chroma-cloud
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseInstructions
说明
Intake
信息采集
Do not block on a long questionnaire. Ask only for details that are missing and required to choose the right path:
- Dense only or hybrid search
- Whether ,
CHROMA_API_KEY, andCHROMA_TENANTare already configuredCHROMA_DATABASE - Existing embedding choice, if any
If the user has no embedding preference, default to Chroma Cloud Qwen. If hybrid search is required, use and . If the task is narrow, such as fixing an existing query, reviewing code, or answering an API question, proceed with the repo context instead of forcing intake.
Schema()Search()不要进行冗长的问卷式询问,仅收集做出正确决策所需的缺失信息:
- 仅稠密搜索还是混合搜索
- 是否已配置、
CHROMA_API_KEY和CHROMA_TENANTCHROMA_DATABASE - 现有嵌入模型选择(如有)
如果用户没有嵌入模型偏好,默认使用Chroma Cloud Qwen。如果需要混合搜索,请使用和。如果任务明确,例如修复现有查询、审查代码或回答API相关问题,请直接基于仓库上下文处理,不要强制进行信息采集。
Schema()Search()What to validate
需要验证的内容
- Correct client import (vs
CloudClient)Client - Environment variables are set for Cloud deployments
- Embedding function package is installed when the selected TypeScript embedding requires one
- and
Schema()are only used for Cloud workflowsSearch() - Important: accepts either an
get_or_create_collection()OR aembedding_function, but not both. Useschemawhen you need multiple indexes, hybrid search, or sparse embeddings; useschemafor simple dense-only search.embedding_function
- 正确的客户端导入(vs
CloudClient)Client - 云部署的环境变量已设置
- 当选择TypeScript嵌入模型时,对应的嵌入函数包已安装
- 和
Schema()仅用于云工作流Search() - 重要提示: 仅接受
get_or_create_collection()或embedding_function其中一个参数,不可同时使用。当需要多索引、混合搜索或稀疏嵌入时使用schema;仅进行简单稠密搜索时使用schema。embedding_function
Quick Start
快速开始
Use the CLI topic to authenticate and write Cloud credentials:
bash
chroma login
chroma db create <db_name>
chroma db connect <db_name> --env-fileThen create a and choose the API based on the search mode:
CloudClienttypescript
import { CloudClient } from 'chromadb';
const client = new CloudClient();
const collection = await client.getOrCreateCollection({ name: 'my_collection' });Use for dense-only search. Use plus only when the user needs hybrid retrieval, multiple indexes, or more expressive ranking/query composition.
collection.query()Schema()Search()使用CLI主题进行身份验证并写入云凭证:
bash
chroma login
chroma db create <db_name>
chroma db connect <db_name> --env-file然后创建并根据搜索模式选择对应API:
CloudClienttypescript
import { CloudClient } from 'chromadb';
const client = new CloudClient();
const collection = await client.getOrCreateCollection({ name: 'my_collection' });使用进行仅稠密搜索。仅当用户需要混合检索、多索引或更具表现力的排序/查询组合时,才使用搭配。
collection.query()Schema()Search()Cloud Guidance
云服务指南
Collections are the main isolation boundary in Chroma Cloud, and metadata is the main filtering mechanism inside a collection. Reach for only when you need explicit dense+sparse or multi-index configuration, and reach for only when is not expressive enough.
Schema()Search()query()在Chroma Cloud中,集合是主要的隔离边界,元数据是集合内部的主要过滤机制。仅当需要显式配置稠密+稀疏或多索引时才使用,仅当功能不够灵活时才使用。
Schema()query()Search()Learn More
了解更多
If you need more detailed information about Chroma beyond what's covered in this skill, fetch Chroma's llms.txt for comprehensive documentation: https://docs.trychroma.com/llms.txt
如果需要本技能未涵盖的Chroma详细信息,可获取Chroma的llms.txt文档以查看完整内容:https://docs.trychroma.com/llms.txt
Available Topics
可用主题
Typescript
TypeScript
- Chroma Regex Filtering - Learn how to use regex filters in Chroma queries
- Query and Get - Query and Get Data from Chroma Collections
- Metadata - Store and query metadata, including filters and array values
- Updating and Deleting - Update existing documents and delete data from collections
- Schema - Schema() configures collections with multiple indexes
- Chroma Cloud Qwen - Chroma's hosted Qwen embedding service
- Error Handling - Handling errors and failures when working with Chroma
- Collection Forking - Instantly duplicate collections using copy-on-write forking in Chroma Cloud
- Search() API - An expressive and flexible API for doing dense and sparse vector search on collections, as well as hybrid search
- Chroma正则表达式过滤 - 学习如何在Chroma查询中使用正则表达式过滤
- 查询与获取 - 从Chroma集合中查询和获取数据
- 元数据 - 存储和查询元数据,包括过滤器和数组值
- 更新与删除 - 更新现有文档并从集合中删除数据
- Schema - Schema()用于配置多索引集合
- Chroma Cloud Qwen - Chroma托管的Qwen嵌入服务
- 错误处理 - 处理使用Chroma时的错误与故障
- 集合分叉 - 在Chroma Cloud中使用写时复制分叉功能快速复制集合
- Search() API - 用于在集合上进行稠密、稀疏向量搜索及混合搜索的灵活API
Python
Python
- Chroma Regex Filtering - Learn how to use regex filters in Chroma queries
- Query and Get - Query and Get Data from Chroma Collections
- Metadata - Store and query metadata, including filters and array values
- Updating and Deleting - Update existing documents and delete data from collections
- Schema - Schema() configures collections with multiple indexes
- Chroma Cloud Qwen - Chroma's hosted Qwen embedding service
- Error Handling - Handling errors and failures when working with Chroma
- Collection Forking - Instantly duplicate collections using copy-on-write forking in Chroma Cloud
- Search() API - An expressive and flexible API for doing dense and sparse vector search on collections, as well as hybrid search
- Chroma正则表达式过滤 - 学习如何在Chroma查询中使用正则表达式过滤
- 查询与获取 - 从Chroma集合中查询和获取数据
- 元数据 - 存储和查询元数据,包括过滤器和数组值
- 更新与删除 - 更新现有文档并从集合中删除数据
- Schema - Schema()用于配置多索引集合
- Chroma Cloud Qwen - Chroma托管的Qwen嵌入服务
- 错误处理 - 处理使用Chroma时的错误与故障
- 集合分叉 - 在Chroma Cloud中使用写时复制分叉功能快速复制集合
- Search() API - 用于在集合上进行稠密、稀疏向量搜索及混合搜索的灵活API
General
通用主题
- Data Model - An overview of how Chroma stores data
- Integrating Chroma into an existing system - Guidance for adding Chroma search to an existing application
- Chroma CLI - Getting started with the Chroma CLI for Chroma Cloud authentication and database management
- Caching Collection References - Reduce repeated collection lookup requests in high-traffic Chroma Cloud applications
- Quotas and Limits - Chroma Cloud quotas and request limits
- 数据模型 - Chroma数据存储方式概述
- 将Chroma集成到现有系统 - 为现有应用添加Chroma搜索功能的指南
- Chroma CLI - 入门使用Chroma CLI进行Chroma Cloud身份验证和数据库管理
- 缓存集合引用 - 减少高流量Chroma Cloud应用中重复的集合查找请求
- 配额与限制 - Chroma Cloud的配额与请求限制