docs infinity rerank api docs

This commit is contained in:
Ishaan Jaff 2024-12-19 18:51:55 -08:00
parent db4cde9d9c
commit ad7dfd2edb
3 changed files with 70 additions and 1 deletions

View file

@ -0,0 +1,67 @@
# Infinity
| Property | Details |
|-------|-------|
| Description | Infinity is a high-throughput, low-latency REST API for serving text-embeddings, reranking models and clip|
| Provider Route on LiteLLM | `infinity/` |
| Supported Operations | `/rerank` |
| Link to Provider Doc | [Infinity ↗](https://github.com/michaelfeil/infinity) |
## **Usage - LiteLLM Python SDK**
```python
from litellm import rerank
response = rerank(
model="infinity/rerank",
query="What is the capital of France?",
documents=["Paris", "London", "Berlin", "Madrid"],
)
```
## **Usage - LiteLLM Proxy**
LiteLLM provides an cohere api compatible `/rerank` endpoint for Rerank calls.
**Setup**
Add this to your litellm proxy config.yaml
```yaml
model_list:
- model_name: custom-infinity-rerank
litellm_params:
model: infinity/rerank
api_key: os.environ/INFINITY_API_KEY
api_base: https://localhost:8080
```
Start litellm
```bash
litellm --config /path/to/config.yaml
# RUNNING on http://0.0.0.0:4000
```
Test request
```bash
curl http://0.0.0.0:4000/rerank \
-H "Authorization: Bearer sk-1234" \
-H "Content-Type: application/json" \
-d '{
"model": "custom-infinity-rerank",
"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
}'
```

View file

@ -116,3 +116,4 @@ curl http://0.0.0.0:4000/rerank \
| Azure AI| [Usage](../docs/providers/azure_ai) | | Azure AI| [Usage](../docs/providers/azure_ai) |
| Jina AI| [Usage](../docs/providers/jina_ai) | | Jina AI| [Usage](../docs/providers/jina_ai) |
| AWS Bedrock| [Usage](../docs/providers/bedrock#rerank-api) | | AWS Bedrock| [Usage](../docs/providers/bedrock#rerank-api) |
| Infinity| [Usage](../docs/providers/infinity) |

View file

@ -186,6 +186,7 @@ const sidebars = {
"providers/fireworks_ai", "providers/fireworks_ai",
"providers/clarifai", "providers/clarifai",
"providers/vllm", "providers/vllm",
"providers/infinity",
"providers/xinference", "providers/xinference",
"providers/cloudflare_workers", "providers/cloudflare_workers",
"providers/deepinfra", "providers/deepinfra",