Chroma 客户端

有多种方法可以实例化客户端以连接到您的 Chroma 数据库。

云客户端

您可以使用 CloudClient 创建一个连接到 Chroma Cloud 的客户端。

import chromadb

client = chromadb.CloudClient(
    tenant='Tenant ID',
    database='Database name',
    api_key='Chroma Cloud API key'
)

CloudClient 仅需 API 密钥参数即可实例化。在这种情况下，我们将从 Chroma Cloud 解析租户（tenant）和数据库（DB）。请注意，只有当提供的 API 密钥作用域仅限单个数据库时，我们的自动解析才会生效。如果您设置了 CHROMA_API_KEY、CHROMA_TENANT 和 CHROMA_DATABASE 环境变量，则只需实例化不带参数的 CloudClient：

client = chromadb.CloudClient()

内存客户端

在 Python 中，您可以运行内存中的 Chroma 服务器，并使用临时客户端进行连接

import chromadb

client = chromadb.Client()

Client() 方法会启动一个内存中的 Chroma 服务器，并返回一个可用于连接的客户端。这在 Python 笔记本中实验不同的嵌入函数和检索技术时非常有用。如果您不需要数据持久化，临时客户端是快速启动 Chroma 的理想选择。

持久化客户端

Python
TypeScript
Rust

您可以使用 PersistentClient 配置 Chroma，使其从本地机器保存和加载数据库。数据将自动持久化，并在启动时加载（如果存在）。

import chromadb

client = chromadb.PersistentClient(path="/path/to/save/to")

path 是 Chroma 在磁盘上存储数据库文件以及启动时加载文件的位置。如果您未提供路径，默认值为 .chroma客户端对象包含一些有用的便捷方法。

heartbeat() - 返回一个纳秒级的心跳。用于确保客户端保持连接状态。
reset() - 清空并完全重置数据库。警告：此操作具有破坏性且不可逆。

client.heartbeat()
client.reset()

要使用 JS/TS 客户端进行连接，您必须连接到 Chroma 服务器。要在本地运行一个可以持久化数据的 Chroma 服务器，请使用任何兼容 npm 的客户端从 npm 安装 Chroma。

npm install chromadb

然后使用我们的 CLI 运行服务器

npx chroma run --path ./getting-started

path 是 Chroma 在磁盘上存储数据库文件以及启动时加载文件的位置。默认值为 .chroma。或者，您也可以使用我们的官方 Docker 镜像：

docker pull chromadb/chroma
docker run -p 8000:8000 chromadb/chroma

本地运行 Chroma 服务器后，您可以通过实例化一个新的 ChromaClient 来连接它

import { ChromaClient } from "chromadb";

const client = new ChromaClient();

默认情况下，ChromaClient 配置为连接到位于 https://:8000 的 Chroma 服务器，并使用 default_tenant 和 default_database。如果您有不同的设置，可以将它们传递给 ChromaClient 构造函数

const client = new ChromaClient({
  ssl: false,
  host: "localhost",
  port: 9000, // non-standard port based on your server config
  database: "my-db",
  headers: {},
});

客户端对象包含一些有用的便捷方法。

heartbeat() - 返回一个纳秒级的心跳。用于确保客户端保持连接状态。
reset() - 清空并完全重置数据库。警告：此操作具有破坏性且不可逆。

await client.heartbeat();
await client.reset();

Rust 客户端连接到正在运行的 Chroma 服务器。对于本地持久化，请使用数据路径运行服务器并通过 HTTP 连接。

chroma run --path /db_path

use chroma::{ChromaHttpClient, ChromaHttpClientOptions};

let mut options = ChromaHttpClientOptions::default();
options.endpoint = "https://:8000".parse()?;

let client = ChromaHttpClient::new(options);
client.heartbeat().await?;

概述

运行 Chroma

集合 (Collections)

查询集合

向量嵌入 (Embeddings)

命令行界面 (CLI)

云客户端

内存客户端

持久化客户端

概述

运行 Chroma

集合 (Collections)

查询集合

向量嵌入 (Embeddings)

命令行界面 (CLI)

​云客户端

​内存客户端

​持久化客户端

云客户端

内存客户端

持久化客户端