chroma-cloud

手順

初回確認

長い質問票への回答を必須にしないでください。適切な進め方を選ぶために不足している必須情報だけを尋ねてください。

• Dense 検索のみか、ハイブリッド検索か
• CHROMA_API_KEY、CHROMA_TENANT、CHROMA_DATABASE がすでに設定されているか
• すでに選択済みの埋め込み方式があるか

ユーザーに埋め込み方式の希望がなければ、Chroma Cloud Qwen をデフォルトにします。ハイブリッド検索が必要な場合は、Schema() と Search() を使用します。既存のクエリの修正、コードのレビュー、API に関する質問など、タスクの範囲が狭い場合は、初回確認を無理に行わず、リポジトリのコンテキストに基づいて進めてください。

検証項目

• 正しいクライアントをインポートしていること（CloudClient と Client のどちらか）
• Cloud のデプロイでは、環境変数が設定されていること
• 選択した TypeScript の埋め込み方式でパッケージが必要な場合、そのパッケージがインストールされていること
• Schema() と Search() は Cloud のワークフローでのみ使用すること
• 重要： get_or_create_collection() には embedding_function または schema のどちらか一方を指定できますが、両方は指定できません。複数のインデックス、ハイブリッド検索、または疎な埋め込みが必要な場合は schema を使用し、シンプルな Dense 検索のみの場合は embedding_function を使用してください。

クイックスタート

CLI トピックを使用して認証し、Cloud の認証情報を書き込みます。

chroma login
chroma db create <db_name>
chroma db connect <db_name> --env-file

次に CloudClient を作成し、検索モードに応じて API を選択します。

import { CloudClient } from 'chromadb';

const client = new CloudClient();
const collection = await client.getOrCreateCollection({ name: 'my_collection' });

Dense 検索のみの場合は collection.query() を使用します。ハイブリッド検索、複数のインデックス、またはより表現力豊かなランキングやクエリの組み立てが必要な場合に限り、Schema() と Search() を組み合わせて使用します。

Cloud に関するガイダンス

Chroma Cloud ではコレクションが主な分離境界であり、コレクション内の主なフィルタリング手段はメタデータです。明示的な Dense と Sparse の設定、または複数インデックスの設定が必要な場合に限り Schema() を使用し、query() では表現力が不足する場合に限り Search() を使用してください。

詳細情報

このスキルで扱っている内容を超える Chroma の詳細情報が必要な場合は、包括的なドキュメントとして Chroma の llms.txt を取得してください：https://docs.trychroma.com/llms.txt

利用可能なトピック

TypeScript

• Chroma Regex Filtering - Chroma のクエリで正規表現フィルターを使用する方法を説明します
• Query and Get - Chroma コレクションのデータをクエリおよび取得します
• Metadata - フィルターや配列値を含むメタデータを保存およびクエリします
• Updating and Deleting - 既存のドキュメントを更新し、コレクションからデータを削除します
• Schema - Schema() で複数のインデックスを持つコレクションを設定します
• Chroma Cloud Qwen - Chroma がホストする Qwen 埋め込みサービスです
• Error Handling - Chroma の使用時に発生するエラーや失敗への対処方法を説明します
• Collection Forking - Chroma Cloud のコピーオンライトフォークを使用して、コレクションをすぐに複製します
• Search() API - コレクションに対する Dense および Sparse ベクトル検索とハイブリッド検索を行うための、表現力豊かで柔軟な API です

Python

• Chroma Regex Filtering - Chroma のクエリで正規表現フィルターを使用する方法を学びます
• Query and Get - Chroma コレクションのデータをクエリおよび取得します
• Metadata - フィルターや配列値を含むメタデータを保存およびクエリします
• Updating and Deleting - 既存のドキュメントを更新し、コレクションからデータを削除します
• Schema - Schema() は複数のインデックスを使用してコレクションを設定します
• Chroma Cloud Qwen - Chroma がホストする Qwen 埋め込みサービス
• Error Handling - Chroma の使用時に発生するエラーや障害への対処方法
• Collection Forking - Chroma Cloud のコピーオンライト方式のフォークを使用して、コレクションを瞬時に複製します
• Search() API - コレクションで高密度およびスパースなベクトル検索やハイブリッド検索を行うための、表現力豊かで柔軟な API

General

• Data Model - Chroma がデータを保存する方法の概要
• Integrating Chroma into an existing system - 既存のアプリケーションに Chroma 検索を追加するためのガイダンス
• Chroma CLI - Chroma Cloud の認証とデータベース管理に Chroma CLI を使い始める方法
• Caching Collection References - トラフィックの多い Chroma Cloud アプリケーションで、コレクションの検索リクエストの繰り返しを減らします
• Quotas and Limits - Chroma Cloud のクォータとリクエスト制限