Skip to content
This repository was archived by the owner on May 10, 2024. It is now read-only.

Commit 3fc6a91

Browse files
author
Joan Fontanals Martinez
committed
docs: add documentation about Jina AI Embedding function
1 parent f66f10b commit 3fc6a91

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/embeddings.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,26 @@ You can pass in an optional `model_name` argument, which lets you choose which H
289289
</TabItem>
290290
</Tabs>
291291

292+
## Jina AI
293+
294+
Chroma provides a convenient wrapper around JinaAI's embedding API. This embedding function runs remotely on JinaAI's servers, and requires an API key. You can get an API key by signing up for an account at [JinaAI](#TODO: Check link).
295+
296+
<Tabs queryString groupId="lang" className="hideTabSwitcher">
297+
<TabItem value="py" label="Python">
298+
299+
This embedding function relies on the `requests` python package, which you can install with `pip install requests`.
300+
301+
```python
302+
jinaai_ef = embedding_functions.JinaAIEmbeddingFunction(
303+
api_key="YOUR_API_KEY",
304+
model_name="jina-embedding-v2-base-en"
305+
)
306+
jinaai_ef(texts=["This is my first text to embed", "This is my second document"])
307+
```
308+
309+
You can pass in an optional `model_name` argument, which lets you choose which JinaAI model to use. By default, Chroma uses `jina-embedding-v2-base-en`. You can see a list of all available models [here](#TODO: Check link).
310+
311+
292312
## Custom Embedding Functions
293313

294314
<Tabs queryString groupId="lang" className="hideTabSwitcher">

0 commit comments

Comments
 (0)