From 8a26786319fe0b13552ff51024880afe64f8ade0 Mon Sep 17 00:00:00 2001 From: Kyle D Date: Thu, 7 Aug 2025 13:25:02 -0700 Subject: [PATCH 1/2] Update docs for Chroma Cloud --- .../general-shared-text/chroma-cli-api.mdx | 12 ++++++++++-- snippets/general-shared-text/chroma.mdx | 19 +++---------------- 2 files changed, 13 insertions(+), 18 deletions(-) diff --git a/snippets/general-shared-text/chroma-cli-api.mdx b/snippets/general-shared-text/chroma-cli-api.mdx index 6fee94c5..04773ced 100644 --- a/snippets/general-shared-text/chroma-cli-api.mdx +++ b/snippets/general-shared-text/chroma-cli-api.mdx @@ -10,8 +10,8 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d The following environment variables: -- `CHROMA_HOST` - The , represented by `--host` (CLI) or `host` (Python). -- `CHROMA_PORT` - The , represented by `--port` (CLI) or `port` (Python). +- `CHROMA_HOST` - The , represented by `--host` (CLI) or `host` (Python). Chroma Cloud uses `api.trychroma.com`. +- `CHROMA_PORT` - The , represented by `--port` (CLI) or `port` (Python). Chroma Cloud uses port `8000`. - `CHROMA_TENANT` - The name of the tenant that you want to access on the Chroma server, represented by `--tenant` (CLI) or `tenant` (Python). - `CHROMA_DATABASE` - The name of the database that you want to access in the tenant, represented by `--database` (CLI) or `database` (Python). - `CHROMA_COLLECTION` - The name of the collection that you want to access in the database, represented by `--collection-name` (CLI) or `collection_name` (Python). @@ -22,3 +22,11 @@ Additional settings include: - `--settings` (CLI) or `settings` (Python): A dictionary of settings to communicate with the Chroma server, for example: `'{"persist_directory":"./chroma-persist"}'`. - `--headers` (CLI) or `headers` (Python): A dictionary of headers to send to the Chroma server, for example: `'{"Authorization":"Basic()"}'`. - `--ssl` (CLI) or `ssl` (Python): True to use SSL for the connection. + +In order to use Chroma Cloud, you should have this configuration: + +- `host=api.trychroma.com` +- `port=8000` +- Get your `tenant` id from the [Chroma dashboard](https://trychroma.com) +- `headers={'x-chroma-token': 'YOUR_API_KEY'}` +- `ssl` should be enabled. diff --git a/snippets/general-shared-text/chroma.mdx b/snippets/general-shared-text/chroma.mdx index bffa4118..18b2fdc3 100644 --- a/snippets/general-shared-text/chroma.mdx +++ b/snippets/general-shared-text/chroma.mdx @@ -1,19 +1,6 @@ -- A Chroma server. See [Deployment](https://docs.trychroma.com/deployment). - - For example, here is a video about how to deploy a Chroma server to AWS: - - - -- The Chroma server's hostname or IP address, and the server's port number. -- If you are not connecting to the server through HTTP, the path to the server instance. +- A Chroma server. You can connect to a [hosted Chroma Cloud server](https://trychroma.com/signup) or [deploy your own server](https://docs.trychroma.com/deployment). +- The Chroma server's hostname or IP address, and the server's port number (Chroma Cloud: host api.trychroma.com, port 8000) +- If you are using local Chroma, the [path to the folder where you store your database](https://docs.trychroma.com/docs/run-chroma/persistent-client) - The name of the tenant that you want to access on the server. - The name of the database that you want to access in the tenant. - The name of the collection that you want to access in the database. From cc50835ecc5d8ee77af6a6b193c5e2e8188dadef Mon Sep 17 00:00:00 2001 From: Paul-Cornell Date: Mon, 11 Aug 2025 15:11:50 -0700 Subject: [PATCH 2/2] Apply suggestions from code review --- snippets/general-shared-text/chroma.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/snippets/general-shared-text/chroma.mdx b/snippets/general-shared-text/chroma.mdx index 18b2fdc3..0bbf0491 100644 --- a/snippets/general-shared-text/chroma.mdx +++ b/snippets/general-shared-text/chroma.mdx @@ -1,6 +1,6 @@ - A Chroma server. You can connect to a [hosted Chroma Cloud server](https://trychroma.com/signup) or [deploy your own server](https://docs.trychroma.com/deployment). -- The Chroma server's hostname or IP address, and the server's port number (Chroma Cloud: host api.trychroma.com, port 8000) -- If you are using local Chroma, the [path to the folder where you store your database](https://docs.trychroma.com/docs/run-chroma/persistent-client) +- The Chroma server's hostname or IP address, and the server's port number. For Chroma Cloud, the host is `api.trychroma.com`, and the port number is `8000`. +- If you are using local Chroma, the [path to the folder where you store your database](https://docs.trychroma.com/docs/run-chroma/persistent-client). - The name of the tenant that you want to access on the server. - The name of the database that you want to access in the tenant. - The name of the collection that you want to access in the database.