Chroma - 面向人工智能的开源数据基础设施.

| | 文档 | 官网

pip install chromadb # Python 客户端
# 对于 JavaScript，使用 npm install chromadb!
# 对于客户端-服务器模式，运行 `chroma run --path /chroma_db_path`

Chroma Cloud

我们的托管服务 Chroma Cloud 提供无服务器的向量搜索、混合搜索和全文搜索功能。它速度极快、成本效益高、可扩展且使用简单。只需不到 30 秒，即可创建一个数据库，并利用 5 美元的免费额度进行试用。

开始使用 Chroma Cloud

API

核心 API 只有 4 个函数（请运行我们的 💡 Google Colab)：

import chromadb
# 设置内存中的 Chroma，便于快速原型开发。也可以轻松添加持久化存储！
client = chromadb.Client()

# 创建集合。还可使用 get_collection、get_or_create_collection 和 delete_collection！
collection = client.create_collection("all-my-documents")

# 向集合中添加文档。也可以更新和删除。基于行的 API 即将推出！
collection.add(
    documents=["这是文档1”，“这是文档2”], # 我们会自动处理分词、嵌入和索引。你也可以跳过这些步骤，直接添加自己的嵌入向量
    metadatas=[{"source": "notion"}, {"source": "google-docs"}], # 可以根据这些元数据进行过滤！
    ids=["doc1", "doc2"], # 每个文档必须有唯一 ID
)

# 查询/搜索最相似的 2 条结果。你也可以按 ID 获取文档。
results = collection.query(
    query_texts=["这是一份查询文档"],
    n_results=2,
    # where={"metadata_field": "is_equal_to_this"}, # 可选过滤条件
    # where_document={"$contains":"search_string"}  # 可选过滤条件
)

更多功能详情，请参阅我们的 文档。

参与贡献

Chroma 是一个快速发展的项目。我们欢迎 Pull Request 贡献者以及任何改进项目的建议。

• 加入 Discord 社区讨论 - #contributing 频道
• 查看 🛣️ 路线图并提出你的想法
• 领取一个问题并提交 PR - Good first issue 标签
• 阅读我们的贡献指南

发布节奏 我们目前每周一发布 pypi 和 npm 包的新版本标签。紧急修复则会在一周内的任何时间发布。

许可证

Apache 2.0

Chroma 快速上手指南

Chroma 是一款专为 AI 打造的开源数据基础设施，提供高效的向量存储、混合搜索及全文检索能力。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows。
• 运行环境：
  • Python 3.8+（推荐 Python 3.10+）
  • Node.js 16+（如需使用 JavaScript 客户端）
• 前置依赖：无需额外安装数据库服务，Chroma 默认支持嵌入式运行。

💡 国内加速建议：如遇网络问题，建议使用国内镜像源安装依赖。

pip install chromadb -i https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

Python 客户端

pip install chromadb

JavaScript 客户端

npm install chromadb

启动独立服务模式（可选）

如需以客户端 - 服务器模式运行（便于多进程访问或持久化存储）：

chroma run --path /chroma_db_path

基本使用

以下是最简单的 Python 使用示例，展示如何创建集合、添加文档并进行相似度查询。

import chromadb

# 初始化客户端（默认内存模式，适合快速原型开发）
client = chromadb.Client()

# 创建集合
collection = client.create_collection("all-my-documents")

# 添加文档
# Chroma 会自动处理分词、嵌入向量和索引，也可手动传入自定义向量
collection.add(
    documents=["This is document1", "This is document2"],
    metadatas=[{"source": "notion"}, {"source": "google-docs"}], # 可用于过滤
    ids=["doc1", "doc2"], # 每个文档的唯一标识
)

# 查询最相似的 2 个结果
results = collection.query(
    query_texts=["This is a query document"],
    n_results=2,
    # where={"metadata_field": "is_equal_to_this"}, # 可选：元数据过滤
    # where_document={"$contains":"search_string"}  # 可选：内容包含过滤
)

print(results)

更多高级功能（如持久化存储、自定义嵌入模型等）请参阅 官方文档。