# @chroma-core/default-embed 中文文档

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

版本：0\.1\.9
npm 元数据更新时间：2025-11-12T21:47:32.995Z
中文译文更新时间：2026-11-09T15:10:03.981Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：30.5 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2025-05-20T21:43:09.032Z
- 最新版本发布：2025-11-12T21:47:32.810Z
- 近 30 天下载量：68592（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 1 个）

## 中文简介

Chroma 的默认嵌入功能

## 安装

```sh
npm install @chroma-core/default-embed
```

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

## README

# Chroma 默认嵌入函数

此软件包为使用Hugging Face Transformers.js的Chroma提供了默认嵌入功能. 它完全运行于内浏览器或节点.js而不需要外部API呼叫.

## 安装

```bash
npm install @chroma-core/default-embed
```

## 使用量

```typescript
import { ChromaClient } from 'chromadb';
import { DefaultEmbeddingFunction } from '@chroma-core/default-embed';

// Initialize with default settings
const embedder = new DefaultEmbeddingFunction();

// Or customize the configuration
const customEmbedder = new DefaultEmbeddingFunction({
  modelName: 'Xenova/all-MiniLM-L6-v2', // Default model
  revision: 'main',
  dtype: 'fp32', // or 'uint8' for quantization
  wasm: false, // Set to true to use WASM backend
});

// 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,
});
```

## 配置选项

-   **模型Name**: hugging Face模型名(默认: `Xenova/all-MiniLM-L6-v2`(中文(简体) )
-   **订正**: 模型修订(默认: `main`(中文(简体) )
-   **d 类型**: 量化的数据类型(`fp32`, (中文(简体) ), `fp16`, (中文(简体) ), `q8`, (中文(简体) ), `uint8`页:1
-   **数量**: 折旧,使用 `dtype` 换成
-   **原声**: 为 ONNX 运行时使用 WASM 后端

## 特征

-   **不需要 API 密钥**: 无外部依赖的本地运行
-   **浏览器兼容性**: 在节点和浏览器环境中工作
-   **量化支持**: 使用各种量化选项来缩小模型大小
-   **WASM 后端软件**: 可选 WASM 支持更好的浏览器性能

默认模式( E)`Xenova/all-MiniLM-L6-v2`)产生384维嵌入并适合大多数通用语义搜索任务.

## 常见问题

### @chroma-core/default-embed 是什么？

Chroma 的默认嵌入功能

### 如何安装 @chroma-core/default-embed？

在项目目录运行 npm install @chroma-core/default-embed，或使用 pnpm add / yarn add / bun add。

### @chroma-core/default-embed 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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

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

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