Client - Chroma — ContextQMD

Clients

EphemeralClient

Create an in-memory client for local use.

This client stores all data in memory and does not persist to disk. It is intended for testing and development.

<ParamField path="settings" type="Optional[Settings]"> Optional settings to override defaults. </ParamField> <ParamField path="tenant" type="str"> Tenant name to use for requests. Defaults to the default tenant. </ParamField> <ParamField path="database" type="str"> Database name to use for requests. Defaults to the default database. </ParamField>

PersistentClient

Create a persistent client that stores data on disk.

This client is intended for local development and testing. For production, prefer a server-backed Chroma instance.

<ParamField path="path" type="Union[str, Path]"> Directory to store persisted data. </ParamField> <ParamField path="settings" type="Optional[Settings]"> Optional settings to override defaults. </ParamField> <ParamField path="tenant" type="str"> Tenant name to use for requests. </ParamField> <ParamField path="database" type="str"> Database name to use for requests. </ParamField>

HttpClient

Create a client that connects to a Chroma server.

<ParamField path="host" type="str"> Hostname of the Chroma server. </ParamField> <ParamField path="port" type="int"> HTTP port of the Chroma server. </ParamField> <ParamField path="ssl" type="bool"> Whether to enable SSL for the connection. </ParamField> <ParamField path="headers" type="Optional[Dict[str, str]]"> Optional headers to send with each request. </ParamField> <ParamField path="settings" type="Optional[Settings]"> Optional settings to override defaults. </ParamField> <ParamField path="tenant" type="str"> Tenant name to use for requests. </ParamField> <ParamField path="database" type="str"> Database name to use for requests. </ParamField>

AsyncHttpClient

Create an async client that connects to a Chroma HTTP server.

This supports multiple clients connecting to the same server and is the recommended production configuration.

CloudClient

Create a client for Chroma Cloud.

If not provided, tenant, database, and api_key will be inferred from the environment variables CHROMA_TENANT, CHROMA_DATABASE, and CHROMA_API_KEY.

<ParamField path="tenant" type="Optional[str]"> Tenant name to use, or None to infer from credentials. </ParamField> <ParamField path="database" type="Optional[str]"> Database name to use, or None to infer from credentials. </ParamField> <ParamField path="api_key" type="Optional[str]"> API key for Chroma Cloud. </ParamField> <ParamField path="settings" type="Optional[Settings]"> Optional settings to override defaults. </ParamField> <ParamField path="cloud_host" type="str" /> <ParamField path="cloud_port" type="int" /> <ParamField path="enable_ssl" type="bool" />

AdminClient

Create an admin client for tenant and database management.

Client Methods

heartbeat

Get the current time in nanoseconds since epoch.

Used to check if the server is alive.

Returns: The current time in nanoseconds since epoch

list_collections

List all collections.

<ParamField path="limit" type="Optional[int]"> The maximum number of entries to return. Defaults to None. </ParamField> <ParamField path="offset" type="Optional[int]"> The number of entries to skip before returning. Defaults to None. </ParamField>

Returns: A list of collections

count_collections

Count the number of collections.

Returns: The number of collections.

create_collection

Create a new collection with the given name and metadata.

<ParamField path="name" type="str" required> The name of the collection to create. </ParamField> <ParamField path="schema" type="Optional[Schema]" /> <ParamField path="configuration" type="Optional[CreateCollectionConfiguration]" /> <ParamField path="metadata" type="Optional[Dict[str, Any]]"> Optional metadata to associate with the collection. </ParamField> <ParamField path="embedding_function" type="Optional[EmbeddingFunction[Optional[Embeddings]]]"> Optional function to use to embed documents. Uses the default embedding function if not provided. </ParamField> <ParamField path="data_loader" type="Optional[DataLoader[Optional[Embeddings]]]"> Optional function to use to load records (documents, images, etc.) </ParamField> <ParamField path="get_or_create" type="bool"> If True, return the existing collection if it exists. </ParamField>

Returns: The newly created collection.

Raises:

ValueError: If the collection already exists and get_or_create is False.
ValueError: If the collection name is invalid.

get_collection

Get a collection with the given name.

<ParamField path="name" type="str" required> The name of the collection to get </ParamField> <ParamField path="embedding_function" type="Optional[EmbeddingFunction[Optional[Embeddings]]]"> Optional function to use to embed documents. Uses the default embedding function if not provided. </ParamField> <ParamField path="data_loader" type="Optional[DataLoader[Optional[Embeddings]]]"> Optional function to use to load records (documents, images, etc.) </ParamField>

Returns: The collection

Raises:

ValueError: If the collection does not exist

get_or_create_collection

Get or create a collection with the given name and metadata.

Args: name: The name of the collection to get or create metadata: Optional metadata to associate with the collection. If the collection already exists, the metadata provided is ignored. If the collection does not exist, the new collection will be created with the provided metadata. embedding_function: Optional function to use to embed documents data_loader: Optional function to use to load records (documents, images, etc.)

Returns: The collection

Examples: python client.get_or_create_collection("my_collection") # collection(name="my_collection", metadata={})

delete_collection

Delete a collection with the given name.

<ParamField path="name" type="str" required> The name of the collection to delete. </ParamField>

Raises:

ValueError: If the collection does not exist.

reset

Resets the database. This will delete all collections and entries.

Returns: True if the database was reset successfully.

get_version

Get the version of Chroma.

Returns: The version of Chroma

get_settings

Get the settings used to initialize.

Returns: The settings used to initialize.

get_max_batch_size

Return the maximum number of records that can be created or mutated in a single call.

Admin Client Methods

create_tenant

Create a new tenant. Raises an error if the tenant already exists.

get_tenant

Get a tenant. Raises an error if the tenant does not exist.

create_database

Create a new database. Raises an error if the database already exists.

get_database

Get a database. Raises an error if the database does not exist.

<ParamField path="name" type="str" required /> <ParamField path="tenant" type="str"> The tenant of the database to get. </ParamField>

delete_database

Delete a database. Raises an error if the database does not exist.

<ParamField path="name" type="str" required /> <ParamField path="tenant" type="str"> The tenant of the database to delete. </ParamField>

list_databases

List all databases for a tenant. Raises an error if the tenant does not exist.

<ParamField path="limit" type="Optional[int]" /> <ParamField path="offset" type="Optional[int]" /> <ParamField path="tenant" type="str"> The tenant to list databases for. </ParamField>