Skip to main content

Chroma

Chroma 是一个面向开发人员效率和体验的 AI 原生开源向量数据库。Chroma 采用 Apache 2.0 许可协议。

本指南提供了使用 Chroma 向量存储 的快速入门概述。如需了解所有 Chroma 功能和配置的详细文档，请访问 API 参考文档。

Chroma Cloud

Chroma Cloud 提供无服务器的向量和全文搜索服务。它速度极快、成本低廉、可扩展性强且使用便捷。只需 30 秒即可创建一个数据库并体验，注册即可获得 5 美元的免费额度。

开始使用 Chroma Cloud

概览​

集成详情​

类包Python 支持包的最新版本
Chroma@langchain/community✅NPM - 版本

安装​

要使用 Chroma 向量存储，你需要安装 @langchain/community 集成包，并将 Chroma JS SDK 作为对等依赖项安装。

本指南还将使用 OpenAI 嵌入，这要求你安装 @langchain/openai 集成包。如果你愿意，也可以使用 其他支持的嵌入模型。

:::提示 请参阅安装集成包的一般说明部分。 :::

yarn add @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",
  tenant: process.env.CHROMA_TENANT,
  database: process.env.CHROMA_DATABASE,
  chromaCloudAPIKey: process.env.CHROMA_API_KEY
});

管理向量存储​

向向量存储中添加项目​

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 参考文档

Was this page helpful?


You can also leave detailed feedback on GitHub.