-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Added API page - Removed feedback form - it is clunky
- Loading branch information
Showing
2 changed files
with
73 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Chroma API | ||
|
||
In this article we will cover the Chroma API in an indepth details. | ||
|
||
## Accessing the API | ||
|
||
If you are running a Chroma server you can access its API at - `http://<chroma_server_host>:<chroma_server_port>/docs` ( | ||
e.g. `http://localhost:8000/docs`). | ||
|
||
## API Endpoints | ||
|
||
TBD | ||
|
||
## Generating Clients | ||
|
||
While Chroma ecosystem has client implementations for many languages, it may be the case you want to roll out your own. | ||
Below we explain some of the options available to you: | ||
|
||
### Using OpenAPI Generator | ||
|
||
The fastest way to build a client is to use the OpenAPI Generator the API spec. | ||
|
||
### Manually Creating a Client | ||
|
||
If you more control over things, you can create your own client by using the API spec as guideline. | ||
|
||
For your convenience we provide some data structures in various languages to help you get started. The important | ||
structures are: | ||
|
||
- Client | ||
- Collection | ||
- Embedding | ||
- Document | ||
- ID | ||
- Metadata | ||
- QueryRequest/QueryResponse | ||
- Include | ||
- Where Filter | ||
- WhereDocument Filter | ||
|
||
##### Python | ||
|
||
##### Typescript | ||
|
||
##### Golang | ||
|
||
##### Java | ||
|
||
##### Rust | ||
|
||
##### Elixir | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters