## 说明 ### 在编写任何代码之前，请收集以下信息： 1. **部署目标**：本地 Chroma 还是 Chroma Cloud？ * 如果是云：他们需要配置 API 密钥、租户和数据库 * 如果是本地的：确定它们是否需要持久存储或临时存储 2. **搜索类型**（仅限云）：仅密集搜索，还是混合搜索？ * 仅密集：设置更简单，适合大多数语义搜索 * 混合（密集 + 稀疏）：更适合关键字密集的查询，使用 SPLADE 3. **嵌入模型**：哪个提供商/模型？ * 默认值：`@chroma-core/default-embed` (TypeScript) 或内置 (Python) * OpenAI：“text-embedding-3-large”最受欢迎，需要“@chroma-core/openai” * 询问用户是否有偏好或现有的提供商 4. **数据结构**：它们索引什么？ * 需要确定分块策略 * 需要设计用于过滤的元数据模式 ### 决策流程 * 用户想要添加搜索 * 询问本地 Chroma 或 Chroma Cloud？ * 局部色度 * 使用带有密集嵌入模型的collection.query() * 色度云 * 询问是否需要混合搜索 * 是的 * 使用 Schema() + Search() API 和 SPLADE 稀疏索引 * 否 * 使用带有密集嵌入模型的collection.query() * 询问哪种嵌入模型 * 设计元数据架构 * 实施数据同步策略 ### 何时提问 vs 继续 **先问：** * 嵌入模型选择（成本和质量影响） * 云部署与本地部署 * 混合搜索与仅密集搜索 * 多租户数据隔离策略 **继续使用合理的默认值：** * 使用 `getOrCreateCollection()` / `get_or_create_collection()` * 使用余弦相似度（最常见） * 块大小低于 8KB * 将源 ID 存储在元数据中以进行更新/删除 ### 要验证什么 * 为云部署设置环境变量 * 正确的客户端导入（`CloudClient` 与 `Client`） * 安装嵌入功能包（TypeScript） * 架构和搜索 API 仅与云一起使用 * **重要提示：** `get_or_create_collection()` 接受 `embedding_function` 或 `schema`，但不能同时接受两者。当需要多个索引（混合搜索）或稀疏嵌入时使用 Schema；使用 embedding_function 进行简单的仅密集搜索。 ## 快速入门 ### Chroma 云设置 (CLI) 要开始使用 Chroma Cloud，请使用 CLI 登录、创建数据库并将您的凭据写入“.env”文件：色度登录色度数据库创建<我的数据库名称> chroma db connect --env-file 这会将带有“CHROMA_API_KEY”、“CHROMA_TENANT”和“CHROMA_DATABASE”的“.env”文件写入当前目录。下面的代码示例从这些环境变量中读取。 **TypeScript（色度云）：** 从 'chromadb' 导入 { CloudClient }；从'@chroma-core/default-embed'导入{DefaultEmbeddingFunction}； const 客户端 = 新的 CloudClient({ apiKey：process.env.CHROMA_API_KEY，租户：process.env.CHROMA_TENANT，数据库：process.env.CHROMA_DATABASE， }); const embeddingFunction = new DefaultEmbeddingFunction(); const 集合 = 等待 client.getOrCreateCollection({ 名称：'我的收藏'，嵌入函数， }); // 添加文档等待集合.add({ ID: ['doc1', 'doc2'], 文档：['第一个文档文本'，'第二个文档文本']， }); // 查询 const 结果 = 等待集合.query({ queryTexts: ['搜索查询'], 结果：5， }); **Python（色度云）：** 导入操作系统导入chromadb 客户端 = chromadb.CloudClient( api_key=os.environ["CHROMA_API_KEY"], 租户=os.environ["CHROMA_TENANT"], 数据库=os.environ["CHROMA_DATABASE"], ）集合 = client.get_or_create_collection(name="my_collection") # 添加文档集合.添加( ids=["doc1", "doc2"], files=["第一个文档文本","第二个文档文本"], ） # 查询结果=集合.查询( query_texts=["搜索查询"], n_结果=5，） ### 了解色度 Chroma 是一个数据库。 Chroma 数据库包含集合。集合包含文档。与关系数据库中的表不同，集合是在应用程序级别创建和销毁的。每个 Chroma 数据库可以有数百万个集合。每个用户、团队或组织可能都有一个集合。 Chroma 中的分区不是按某个键对表进行分区，而是集合。集合没有行，它们有文档，文档是要搜索的文本数据。创建或更新数据时，客户端将创建数据的嵌入。这是根据提供给客户端的嵌入函数在客户端完成的。为了创建嵌入，客户端将使用其配置通过嵌入函数调用定义的嵌入模型提供程序。这可能发生在进程中，但绝大多数发生在通过 HTTP 的第三方服务上。有多种方法可以使用文档元数据进一步分区或过滤数据。每个文档都有一个元数据的键/值对象。键是字符串，值可以是字符串、整数或布尔值。元数据有多种运算符。在查询期间，使用集合定义的嵌入函数嵌入查询文本，然后将其与其余查询参数一起发送到 Chroma。然后，Chroma 将考虑任何查询参数（例如元数据过滤器）以减少潜在的结果集，然后使用查询向量与正在查询的集合中的向量索引之间的距离算法搜索最近的邻居。通过在 Chroma 客户端上使用“get_or_create_collection()”（TypeScript 中的“getOrCreateCollection()”），可以轻松处理集合，从而避免烦人的样板代码。 ### 本地与云 Chroma 可以作为进程在本地运行，也可以通过 Chroma Cloud 在云中使用。本地可以完成的所有事情都可以在云端完成，但云端可以完成的事情却不一定可以在本地完成。开发者体验的最大区别是 Schema() 和 Search() API，这些 API 仅在 Chroma Cloud 上可用。否则，唯一需要改变的是从Chroma包导入的客户端，界面是一样的。如果您使用云，您可能需要使用 Schema() 和 Search() API。此外，如果用户想要使用云，请询问他们想要使用什么类型的搜索。只是密集嵌入或混合。如果是混合的，您可能希望使用 SPLADE 作为稀疏嵌入策略。 ### 嵌入使用嵌入函数时，可以使用默认嵌入函数，但它通常不是最佳选择。推荐的选项是使用 Chroma Cloud Qwen。打字稿：`npm install @chroma-core/chroma-cloud-qwen`，python，包含但需要`pip install httpx`。在 typescript 中，您需要为每个嵌入功能安装一个包，根据用户的说法安装正确的包。请注意，Chroma 对 SPLADE 和 Qwen 有服务器端嵌入支持（通过 typescript 中的 @chroma-core/chroma-cloud-qwen），所有其他嵌入功能都将是外部的。 ## 了解更多如果您需要超出本技能涵盖范围的有关 Chroma 的更多详细信息，请获取 Chroma 的 llms.txt 以获取全面的文档： ## 可用主题 ### 打字稿 * [Chroma 正则表达式过滤]() \- 了解如何在 Chroma 查询中使用正则表达式过滤器 * [查询和获取]() \- 从 Chroma 集合中查询和获取数据 * [Schema]() \- Schema() 配置具有多个索引的集合 * [更新和删除]() \- 更新现有文档并从集合中删除数据 * [错误处理]() \- 使用 Chroma 时处理错误和失败 * [本地色度]() \- 如何运行和使用本地色度 * [Search() API]() \- 一个富有表现力且灵活的 API，用于对集合进行密集和稀疏向量搜索以及混合搜索 ###Python * [Chroma 正则表达式过滤]() \- 了解如何在 Chroma 查询中使用正则表达式过滤器 * [查询和获取]() \- 从 Chroma 集合中查询和获取数据 * [Schema]() \- Schema() 配置具有多个索引的集合 * [更新和删除]() \- 更新现有文档并从集合中删除数据 * [错误处理]() \- 使用 Chroma 时处理错误和失败 * [本地色度]() \- 如何运行和使用本地色度 * [Search() API]() \- 一个富有表现力且灵活的 API，用于对集合进行密集和稀疏向量搜索以及混合搜索 ## 一般 * [Chroma CLI]() \- 开始使用 Chroma CLI 进行云数据库管理 * [数据模型]() \- Chroma 如何存储数据的概述 * [将 Chroma 集成到现有系统中]() \- 将 Chroma 搜索添加到现有应用程序的指南

色度

包含技能