← Corpus / lossless-monorepo / agent-skill

lossless-monorepo/agent-skills/chroma-agent-skills/skills/chroma-cloud/error-handling/python

Handling errors and failures when working with Chroma

Path
agent-skills/chroma-agent-skills/skills/chroma-cloud/error-handling/python.md

Error Handling

Chroma Cloud operations can fail for various reasons: authentication problems, missing Cloud resources, invalid data, or quota limits. This guide covers common error scenarios and how to handle them.

import json
import os
import time

import chromadb
from chromadb.errors import NotFoundError

Error types

Python uses specific exception classes:

  • chromadb.errors.NotFoundError - Collection, tenant, or database doesn’t exist
  • ValueError - Invalid collection name or duplicate creation attempt

TypeScript throws standard Error objects with descriptive messages. Check the error message to determine the cause.

Connection errors

Connection failures occur when the client can’t reach Chroma Cloud or when network/auth configuration is wrong.

def connect_with_retry(max_retries: int = 3) -> chromadb.ClientAPI:
    """Connect to Chroma Cloud with exponential backoff retry."""
    client = chromadb.CloudClient(**get_cloud_config())

    for attempt in range(1, max_retries + 1):
        try:
            client.heartbeat()
            return client
        except Exception as e:
            if attempt == max_retries:
                raise ConnectionError(
                    f"Failed to connect to Chroma Cloud after {max_retries} attempts: {e}"
                )

            time.sleep(2 ** (attempt - 1))

    raise ConnectionError("Unreachable")

Collection not found

When working with collections that may not exist, handle the NotFoundError (Python) or catch the error and check its message (TypeScript).

client = chromadb.CloudClient(**get_cloud_config())

try:
    collection = client.get_collection(name="my_collection")
except NotFoundError:
    print("Collection not found, creating it...")
    collection = client.get_or_create_collection(name="my_collection")

Safe collection access pattern

The getOrCreateCollection method is the recommended way to avoid “not found” errors entirely. Use getCollection only when you specifically need to verify a collection exists.

client = chromadb.CloudClient(**get_cloud_config())
collection = client.get_or_create_collection(name="my_collection")

results = collection.query(
    query_texts=["search query"],
    n_results=5,
)

if results["documents"] and len(results["documents"][0]) > 0:
    first_doc = results["documents"][0][0]
else:
    pass

Validation errors

Chroma validates data before operations. Common validation failures include:

  • Document content exceeding 16KB
  • Embedding dimensions not matching the collection
  • Metadata exceeding limits (4KB total, 32 keys max)
  • Invalid collection names
client = chromadb.CloudClient(**get_cloud_config())


def validate_document(doc: str) -> bool:
    byte_size = len(doc.encode("utf-8"))
    return byte_size <= 16384


def validate_metadata(metadata: dict) -> bool:
    if len(metadata.keys()) > 32:
        return False

    json_size = len(json.dumps(metadata).encode("utf-8"))
    return json_size <= 4096


def safe_add(
    collection_name: str,
    ids: list[str],
    documents: list[str],
    metadatas: list[dict] | None = None,
) -> None:
    for doc in documents:
        if not validate_document(doc):
            raise ValueError("Document exceeds 16KB limit")

    if metadatas:
        for meta in metadatas:
            if not validate_metadata(meta):
                raise ValueError("Metadata exceeds limits (4KB or 32 keys)")

    collection = client.get_or_create_collection(name=collection_name)
    collection.add(ids=ids, documents=documents, metadatas=metadatas)

Batch operation failures

When adding or upserting multiple documents, a single invalid document fails the entire batch. Validate data before sending, or implement retry logic for partial failures.

client = chromadb.CloudClient(**get_cloud_config())


def batch_add(
    collection_name: str,
    ids: list[str],
    documents: list[str],
    batch_size: int = 100,
) -> dict:
    collection = client.get_or_create_collection(name=collection_name)
    failures = []

    for i in range(0, len(ids), batch_size):
        batch_ids = ids[i : i + batch_size]
        batch_docs = documents[i : i + batch_size]

        try:
            collection.add(ids=batch_ids, documents=batch_docs)
        except Exception as e:
            failures.append({"index": i, "error": str(e)})

    total_batches = (len(ids) + batch_size - 1) // batch_size
    return {"total_batches": total_batches, "failures": failures}

Cloud-specific errors

Chroma Cloud has additional failure modes:

  • Authentication errors - Invalid or expired API key
  • Quota exceeded - Rate limits or storage limits reached
  • Tenant/database not found - Incorrect configuration
def create_cloud_client() -> chromadb.ClientAPI:
    """Create CloudClient with error handling."""
    client = chromadb.CloudClient(**get_cloud_config())

    try:
        client.heartbeat()
        return client
    except Exception as e:
        error_msg = str(e).lower()
        if "401" in error_msg or "unauthorized" in error_msg:
            raise PermissionError("Invalid or expired API key") from e
        if "404" in error_msg or "not found" in error_msg:
            raise NotFoundError(
                "Tenant or database not found - check configuration"
            ) from e
        if "429" in error_msg or "rate" in error_msg:
            raise RuntimeError("Rate limit exceeded - implement backoff") from e
        raise

Defensive patterns summary

ScenarioRecommended approach
Collection accessUse getOrCreateCollection instead of getCollection
Missing dataCheck results length before accessing
Connection issuesImplement retry with exponential backoff
Large batchesValidate data size before operations
Cloud authVerify environment variables are set