# @chroma-core/openai 中文文档

规范地址：https://npmcn.com/package/%40chroma-core/openai/

版本：0\.1\.10
npm 元数据更新时间：2026-03-10T16:32:14.748Z
中文译文更新时间：2026-11-09T15:10:05.883Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chroma-core/openai
原文对照：https://npmcn.com/package/%40chroma-core/openai/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：29.9 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- peer 依赖：chromadb ^3\.3\.2
- 首次发布：2025-05-23T07:49:47.261Z
- 最新版本发布：2026-03-10T16:32:14.608Z
- 近 30 天下载量：35426（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 3 个）

## 中文简介

Chroma 的 OpenAI 嵌入提供者

## 安装

```sh
npm install @chroma-core/openai
```

也可以使用：`pnpm add @chroma-core/openai`、`yarn add @chroma-core/openai`、`bun add @chroma-core/openai`

## README

# OpenAI Chroma 嵌入函数

此软件包为Chroma提供了OpenAI嵌入提供商.

## 安装

```bash
npm install @chroma-core/openai
```

## 使用量

```typescript
import { ChromaClient } from 'chromadb';
import { OpenAIEmbeddingFunction } from '@chroma-core/openai';

// Initialize the embedder
const embedder = new OpenAIEmbeddingFunction({
  apiKey: 'your-api-key', // Or set OPENAI_API_KEY env var
  modelName: 'text-embedding-3-small',
  // Optional: specify dimensions for supported models
  dimensions: 512,
  // Optional: specify organization ID
  organizationId: 'your-org-id',
  // Optional: specify API base (e.g. for Azure OpenAI)
  apiBase: 'your-api-base'
});

// Create a new ChromaClient
const client = new ChromaClient({
  path: 'http://localhost:8000',
});

// Create a collection with the embedder
const collection = await client.createCollection({
  name: 'my-collection',
  embeddingFunction: embedder,
});

// Add documents
await collection.add({
  ids: ["1", "2", "3"],
  documents: ["Document 1", "Document 2", "Document 3"],
});

// Query documents
const results = await collection.query({
  queryTexts: ["Sample query"],
  nResults: 2,
});
```

## 配置

将您的 OpenAI API 密钥设定为环境变量 :

```bash
export OPENAI_API_KEY=your-api-key
```

或者直接传给建筑师.

## 支持的模式

-   `text-embedding-3-small` (默认)
-   `text-embedding-3-large`
-   `text-embedding-ada-002`

对于支持它的模型(如 `text-embedding-3-small` 财务报告和审定财务报表 `text-embedding-3-large`),可以指定自定义维度来缩小嵌入大小.

## 常见问题

### @chroma-core/openai 是什么？

Chroma 的 OpenAI 嵌入提供者

### 如何安装 @chroma-core/openai？

在项目目录运行 npm install @chroma-core/openai，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：chromadb（^3\.3\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @chroma-core/openai 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @chroma-core/openai 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @chroma-core/openai 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @chroma-core/openai 可以商用吗？

@chroma-core/openai 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @chroma-core/openai 的下载量有多少？

根据 npm 官方下载统计，@chroma-core/openai 在 2026/10/10 – 2026/11/08 这 30 天内被下载 35,426 次，日均约 1,181 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @chroma-core/openai 还在维护吗？

最新版本 0\.1\.10 发布于 2026/03/11（8 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 3 个；首次发布于 2025/05/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。