forked from phoenix/litellm-mirror
docs: add docs on jina ai rerank support
This commit is contained in:
parent
89678ace00
commit
499780eff2
3 changed files with 150 additions and 2 deletions
|
@ -973,7 +973,7 @@ response = completion(
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</TabItem value="proxy" label="PROXY">
|
<TabItem value="proxy" label="PROXY">
|
||||||
|
|
||||||
1. Setup config.yaml
|
1. Setup config.yaml
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,13 @@
|
||||||
|
import Tabs from '@theme/Tabs';
|
||||||
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
# Jina AI
|
# Jina AI
|
||||||
https://jina.ai/embeddings/
|
https://jina.ai/embeddings/
|
||||||
|
|
||||||
|
Supported endpoints:
|
||||||
|
- /embeddings
|
||||||
|
- /rerank
|
||||||
|
|
||||||
## API Key
|
## API Key
|
||||||
```python
|
```python
|
||||||
# env variable
|
# env variable
|
||||||
|
@ -8,6 +15,10 @@ os.environ['JINA_AI_API_KEY']
|
||||||
```
|
```
|
||||||
|
|
||||||
## Sample Usage - Embedding
|
## Sample Usage - Embedding
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<TabItem value="sdk" label="SDK">
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from litellm import embedding
|
from litellm import embedding
|
||||||
import os
|
import os
|
||||||
|
@ -19,6 +30,142 @@ response = embedding(
|
||||||
)
|
)
|
||||||
print(response)
|
print(response)
|
||||||
```
|
```
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="proxy" label="PROXY">
|
||||||
|
|
||||||
|
1. Add to config.yaml
|
||||||
|
```yaml
|
||||||
|
model_list:
|
||||||
|
- model_name: embedding-model
|
||||||
|
litellm_params:
|
||||||
|
model: jina_ai/jina-embeddings-v3
|
||||||
|
api_key: os.environ/JINA_AI_API_KEY
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Start proxy
|
||||||
|
|
||||||
|
```bash
|
||||||
|
litellm --config /path/to/config.yaml
|
||||||
|
|
||||||
|
# RUNNING on http://0.0.0.0:4000/
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Test it!
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -L -X POST 'http://0.0.0.0:4000/embeddings' \
|
||||||
|
-H 'Authorization: Bearer sk-1234' \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{"input": ["hello world"], "model": "embedding-model"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
## Sample Usage - Rerank
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<TabItem value="sdk" label="SDK">
|
||||||
|
|
||||||
|
```python
|
||||||
|
from litellm import rerank
|
||||||
|
import os
|
||||||
|
|
||||||
|
os.environ["JINA_AI_API_KEY"] = "sk-..."
|
||||||
|
|
||||||
|
query = "What is the capital of the United States?"
|
||||||
|
documents = [
|
||||||
|
"Carson City is the capital city of the American state of Nevada.",
|
||||||
|
"The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
|
||||||
|
"Washington, D.C. is the capital of the United States.",
|
||||||
|
"Capital punishment has existed in the United States since before it was a country.",
|
||||||
|
]
|
||||||
|
|
||||||
|
response = rerank(
|
||||||
|
model="jina_ai/jina-reranker-v2-base-multilingual",
|
||||||
|
query=query,
|
||||||
|
documents=documents,
|
||||||
|
top_n=3,
|
||||||
|
)
|
||||||
|
print(response)
|
||||||
|
```
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="proxy" label="PROXY">
|
||||||
|
|
||||||
|
1. Add to config.yaml
|
||||||
|
```yaml
|
||||||
|
model_list:
|
||||||
|
- model_name: rerank-model
|
||||||
|
litellm_params:
|
||||||
|
model: jina_ai/jina-reranker-v2-base-multilingual
|
||||||
|
api_key: os.environ/JINA_AI_API_KEY
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Start proxy
|
||||||
|
|
||||||
|
```bash
|
||||||
|
litellm --config /path/to/config.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Test it!
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -L -X POST 'http://0.0.0.0:4000/rerank' \
|
||||||
|
-H 'Authorization: Bearer sk-1234' \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{
|
||||||
|
"model": "rerank-model",
|
||||||
|
"query": "What is the capital of the United States?",
|
||||||
|
"documents": [
|
||||||
|
"Carson City is the capital city of the American state of Nevada.",
|
||||||
|
"The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
|
||||||
|
"Washington, D.C. is the capital of the United States.",
|
||||||
|
"Capital punishment has existed in the United States since before it was a country."
|
||||||
|
],
|
||||||
|
"top_n": 3
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
## Supported Models
|
## Supported Models
|
||||||
All models listed here https://jina.ai/embeddings/ are supported
|
All models listed here https://jina.ai/embeddings/ are supported
|
||||||
|
|
||||||
|
## Supported Optional Rerank Parameters
|
||||||
|
|
||||||
|
All cohere rerank parameters are supported.
|
||||||
|
|
||||||
|
## Supported Optional Embeddings Parameters
|
||||||
|
|
||||||
|
```
|
||||||
|
dimensions
|
||||||
|
```
|
||||||
|
|
||||||
|
## Provider-specific parameters
|
||||||
|
|
||||||
|
Pass any jina ai specific parameters as a keyword argument to the `embedding` or `rerank` function, e.g.
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<TabItem value="sdk" label="SDK">
|
||||||
|
|
||||||
|
```python
|
||||||
|
response = embedding(
|
||||||
|
model="jina_ai/jina-embeddings-v3",
|
||||||
|
input=["good morning from litellm"],
|
||||||
|
dimensions=1536,
|
||||||
|
my_custom_param="my_custom_value", # any other jina ai specific parameters
|
||||||
|
)
|
||||||
|
```
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="proxy" label="PROXY">
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -L -X POST 'http://0.0.0.0:4000/embeddings' \
|
||||||
|
-H 'Authorization: Bearer sk-1234' \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{"input": ["good morning from litellm"], "model": "jina_ai/jina-embeddings-v3", "dimensions": 1536, "my_custom_param": "my_custom_value"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
|
@ -114,3 +114,4 @@ curl http://0.0.0.0:4000/rerank \
|
||||||
| Cohere | [Usage](#quick-start) |
|
| Cohere | [Usage](#quick-start) |
|
||||||
| Together AI| [Usage](../docs/providers/togetherai) |
|
| Together AI| [Usage](../docs/providers/togetherai) |
|
||||||
| Azure AI| [Usage](../docs/providers/azure_ai) |
|
| Azure AI| [Usage](../docs/providers/azure_ai) |
|
||||||
|
| Jina AI| [Usage](../docs/providers/jina_ai) |
|
Loading…
Add table
Add a link
Reference in a new issue