Skip to content

Commit db7d46d

Browse files
Update docs for Chroma Cloud (#710)
Co-authored-by: Paul-Cornell <[email protected]>
1 parent ffbaa0a commit db7d46d

File tree

2 files changed

+13
-18
lines changed

2 files changed

+13
-18
lines changed

snippets/general-shared-text/chroma-cli-api.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d
1010

1111
The following environment variables:
1212

13-
- `CHROMA_HOST` - The , represented by `--host` (CLI) or `host` (Python).
14-
- `CHROMA_PORT` - The , represented by `--port` (CLI) or `port` (Python).
13+
- `CHROMA_HOST` - The , represented by `--host` (CLI) or `host` (Python). Chroma Cloud uses `api.trychroma.com`.
14+
- `CHROMA_PORT` - The , represented by `--port` (CLI) or `port` (Python). Chroma Cloud uses port `8000`.
1515
- `CHROMA_TENANT` - The name of the tenant that you want to access on the Chroma server, represented by `--tenant` (CLI) or `tenant` (Python).
1616
- `CHROMA_DATABASE` - The name of the database that you want to access in the tenant, represented by `--database` (CLI) or `database` (Python).
1717
- `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:
2222
- `--settings` (CLI) or `settings` (Python): A dictionary of settings to communicate with the Chroma server, for example: `'{"persist_directory":"./chroma-persist"}'`.
2323
- `--headers` (CLI) or `headers` (Python): A dictionary of headers to send to the Chroma server, for example: `'{"Authorization":"Basic()"}'`.
2424
- `--ssl` (CLI) or `ssl` (Python): True to use SSL for the connection.
25+
26+
In order to use Chroma Cloud, you should have this configuration:
27+
28+
- `host=api.trychroma.com`
29+
- `port=8000`
30+
- Get your `tenant` id from the [Chroma dashboard](https://trychroma.com)
31+
- `headers={'x-chroma-token': 'YOUR_API_KEY'}`
32+
- `ssl` should be enabled.
Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
1-
- A Chroma server. See [Deployment](https://docs.trychroma.com/deployment).
2-
3-
For example, here is a video about how to deploy a Chroma server to AWS:
4-
5-
<iframe
6-
width="560"
7-
height="315"
8-
src="https://www.youtube.com/embed/4ApW6ZwqW20"
9-
title="YouTube video player"
10-
frameborder="0"
11-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
12-
allowfullscreen
13-
></iframe>
14-
15-
- The Chroma server's hostname or IP address, and the server's port number.
16-
- If you are not connecting to the server through HTTP, the path to the server instance.
1+
- 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).
2+
- 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`.
3+
- 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).
174
- The name of the tenant that you want to access on the server.
185
- The name of the database that you want to access in the tenant.
196
- The name of the collection that you want to access in the database.

0 commit comments

Comments
 (0)