chroma

环境要求

• Python 环境（用于 pip 安装 Python 客户端）
• Node.js/npm 环境（用于安装 JavaScript 客户端）
• 客户端-服务器模式需准备一个本地数据目录，如 /chroma_db_path
• 可选：Chroma Cloud 账号（托管服务，注册含 5 美元免费额度）

安装与启动步骤

1. 1安装 Python 客户端

   README 给出的 Python 安装方式，安装后即可在代码中 import chromadb，无需单独部署服务。

   pip install chromadb

   复制

2. 2安装 JS 客户端

   使用 JavaScript/Node.js 项目时改用 npm 安装，README 明确提示 npm install chromadb。

   npm install chromadb

   复制

3. 3启动本地服务端

   需要客户端-服务器模式时执行，--path 指定数据存放路径，README 中示例为 /chroma_db_path。

   chroma run --path /chroma_db_path

   复制

4. 4创建客户端

   内存模式适合快速原型，README 说明该方式可轻松改为持久化，无需额外配置。

   import chromadb
   client = chromadb.Client()

   复制

5. 5创建集合

   用 create_collection 建立集合，README 提到 get_collection、get_or_create_collection 等同样可用。

   collection = client.create_collection("all-my-documents")

   复制

6. 6添加文档

   调用 collection.add 写入文档，README 说明也支持更新和删除，后续还会推出行式 API。

   collection.add(
       documents=["This is document1", "This is document2"],
   )

   复制

关键配置

如何确认成功

执行示例 Python 代码无报错，create_collection 成功返回集合对象，即说明客户端与集合初始化成功。

常见问题

注意事项

• README 未提供 Docker、源码编译等安装方式，请勿自行推测相关命令。
• pip/npm 安装的均为客户端，服务端模式还需额外执行 chroma run --path。
• README 中的 Python 调用示例被截断，实际参数请以官方文档 docs.trychroma.com 为准。
• Chroma Cloud 为付费托管服务，需先在 trychroma.com/signup 注册开通。