Skip to main content
Chroma 是一个专注于开发者生产力和幸福感的 AI 原生开源向量数据库。Chroma 依据 Apache 2.0 许可。 本指南提供了 Chroma 向量存储 入门的快速概述。有关所有 Chroma 功能和配置的详细文档，请参阅 API 参考。
Chroma CloudChroma Cloud 支持无服务器向量和全文搜索。它速度极快、经济高效、可扩展且无痛。在 30 秒内创建一个数据库并使用 $5 的免费积分进行试用。开始使用 Chroma Cloud

​
概述

​
集成详细信息

类包PY 支持版本
Chroma@langchain/community✅NPM - Version

​
设置

要使用 Chroma 向量存储，您需要安装 @langchain/community 集成包，并将 Chroma JS SDK 作为对等依赖项。 本指南还将使用 OpenAI 嵌入，这需要您安装 @langchain/openai 集成包。如果您愿意，也可以使用 其他支持的嵌入模型。 
npm install @langchain/community @langchain/openai @langchain/core chromadb
如果您想在本地运行 Chroma，您可以使用 Chroma CLI 运行本地 Chroma 服务器，该 CLI 随 chromadb 包一起提供： 
chroma run
您还可以使用官方 Chroma 镜像在 Docker 上运行服务器： 
docker pull chromadb/chroma
docker run -p 8000:8000 chromadb/chroma

​
凭据

如果您在本地运行 Chroma，则无需提供任何凭据。 如果您是 Chroma Cloud 用户，请设置您的 CHROMA_TENANT、CHROMA_DATABASE 和 CHROMA_API_KEY 环境变量。 Chroma CLI 可以为您设置这些。首先，通过 CLI 登录，然后使用 connect 命令： 
chroma db connect [db_name] --env-file
如果您在本指南中使用 OpenAI 嵌入，您还需要设置您的 OpenAI 密钥： 
process.env.OPENAI_API_KEY = "YOUR_API_KEY";
如果您想获得模型调用的自动跟踪，还可以通过取消注释下方内容来设置您的 LangSmith API 密钥： 
// process.env.LANGSMITH_TRACING="true"
// process.env.LANGSMITH_API_KEY="your-api-key"

​
实例化

​
设置您的嵌入函数

首先，选择您的嵌入函数。这里我们使用 OpenAIEmbeddings： 
import { OpenAIEmbeddings } from "@langchain/openai";

const embeddings = new OpenAIEmbeddings({
  model: "text-embedding-3-small",
});

​
本地运行

简单的 Chroma 实例化将连接到在 http://localhost:8000 上本地运行的 Chroma 服务器： 
import { Chroma } from "@langchain/community/vectorstores/chroma";

const vectorStore = new Chroma(embeddings, {
  collectionName: "a-test-collection"
});
如果您使用不同的配置运行 Chroma 服务器，您可以指定 host、port 以及是否使用 ssl 连接： 
import { Chroma } from "@langchain/community/vectorstores/chroma";

const vectorStore = new Chroma(embeddings, {
  collectionName: "a-test-collection",
  host: "your-host-address",
  port: 8080
});

​
Chroma cloud

要连接到 Chroma Cloud，请提供您的 tenant、database 和 chromaCloudAPIKey： 
import { Chroma } from "@langchain/community/vectorstores/chroma";

const vectorStore = new Chroma(embeddings, {
  collectionName: "a-test-collection",
  chromaCloudAPIKey: process.env.CHROMA_API_KEY,
  clientParams: {
    host: "api.trychroma.com",
    port: 8000,
    ssl: true,
    tenant: process.env.CHROMA_TENANT,
    database: process.env.CHROMA_DATABASE,
  },
});

​
管理向量存储

​
向向量存储添加项目

import type { Document } from "@langchain/core/documents";

const document1: Document = {
  pageContent: "The powerhouse of the cell is the mitochondria",
  metadata: { source: "https://example.com" }
};

const document2: Document = {
  pageContent: "Buildings are made out of brick",
  metadata: { source: "https://example.com" }
};

const document3: Document = {
  pageContent: "Mitochondria are made out of lipids",
  metadata: { source: "https://example.com" }
};

const document4: Document = {
  pageContent: "The 2024 Olympics are in Paris",
  metadata: { source: "https://example.com" }
}

const documents = [document1, document2, document3, document4];

await vectorStore.addDocuments(documents, { ids: ["1", "2", "3", "4"] });

​
从向量存储中删除项目

您可以按 ID 从 Chroma 中删除文档，如下所示： 
await vectorStore.delete({ ids: ["4"] });

​
查询向量存储

一旦您的向量存储已创建并且相关文档已添加，您很可能希望在运行链或代理期间查询它。

​
直接查询

执行简单的相似度搜索可以按如下方式完成： 
const filter = { source: "https://example.com" };

const similaritySearchResults = await vectorStore.similaritySearch("biology", 2, filter);

for (const doc of similaritySearchResults) {
  console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
}
有关 Chroma 过滤器语法的更多信息，请参阅 此页面。 如果您想执行相似度搜索并接收相应的分数，您可以运行： 
const similaritySearchWithScoreResults = await vectorStore.similaritySearchWithScore("biology", 2, filter)

for (const [doc, score] of similaritySearchWithScoreResults) {
  console.log(`* [SIM=${score.toFixed(3)}] ${doc.pageContent} [${JSON.stringify(doc.metadata)}]`);
}

​
通过转换为检索器进行查询

您还可以将向量存储转换为 检索器，以便在链中更轻松地使用。 
const retriever = vectorStore.asRetriever({
  // Optional filter
  filter: filter,
  k: 2,
});
await retriever.invoke("biology");

​
用于检索增强生成

有关如何使用此向量存储进行检索增强生成 (RAG) 的指南，请参阅以下部分：

​
API 参考

有关所有 Chroma 功能和配置的详细文档，请参阅 API 参考
在 GitHub 上编辑此页面 或 提交问题。
将这些文档连接 到 Claude、VSCode 等，通过 MCP 获取实时解答。