You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: snippets/general-shared-text/chroma-cli-api.mdx
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,8 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d
10
10
11
11
The following environment variables:
12
12
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`.
15
15
-`CHROMA_TENANT` - The name of the tenant that you want to access on the Chroma server, represented by `--tenant` (CLI) or `tenant` (Python).
16
16
-`CHROMA_DATABASE` - The name of the database that you want to access in the tenant, represented by `--database` (CLI) or `database` (Python).
17
17
-`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:
22
22
-`--settings` (CLI) or `settings` (Python): A dictionary of settings to communicate with the Chroma server, for example: `'{"persist_directory":"./chroma-persist"}'`.
23
23
-`--headers` (CLI) or `headers` (Python): A dictionary of headers to send to the Chroma server, for example: `'{"Authorization":"Basic()"}'`.
24
24
-`--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)
- 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).
17
4
- The name of the tenant that you want to access on the server.
18
5
- The name of the database that you want to access in the tenant.
19
6
- The name of the collection that you want to access in the database.
0 commit comments