From 694a9f0f4c353a1d069efdcc8b4edf1b2344e733 Mon Sep 17 00:00:00 2001 From: Sameer Kankute <135028480+kankute-sameer@users.noreply.github.com> Date: Fri, 22 Aug 2025 22:21:42 +0530 Subject: [PATCH] [Documentation] Litellm rerank deepinfra endpoint (#13845) * Add documentation for deepinfra rerank endpoint * Add the missed import * fix supported param --- docs/my-website/docs/providers/deepinfra.md | 140 ++++++++++++++++++++ docs/my-website/docs/rerank.md | 3 +- 2 files changed, 142 insertions(+), 1 deletion(-) diff --git a/docs/my-website/docs/providers/deepinfra.md b/docs/my-website/docs/providers/deepinfra.md index 1360117445f..ddf6122cac8 100644 --- a/docs/my-website/docs/providers/deepinfra.md +++ b/docs/my-website/docs/providers/deepinfra.md @@ -1,3 +1,6 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # DeepInfra https://deepinfra.com/ @@ -7,6 +10,11 @@ https://deepinfra.com/ ::: +## Table of Contents + +- [API Key](#api-key) +- [Chat Models](#chat-models) +- [Rerank Endpoint](#rerank-endpoint) ## API Key ```python @@ -53,3 +61,135 @@ for chunk in response: | codellama/CodeLlama-34b-Instruct-hf | `completion(model="deepinfra/codellama/CodeLlama-34b-Instruct-hf", messages)` | | mistralai/Mistral-7B-Instruct-v0.1 | `completion(model="deepinfra/mistralai/Mistral-7B-Instruct-v0.1", messages)` | | jondurbin/airoboros-l2-70b-gpt4-1.4.1 | `completion(model="deepinfra/jondurbin/airoboros-l2-70b-gpt4-1.4.1", messages)` | + +## Rerank Endpoint + +LiteLLM provides a Cohere API compatible `/rerank` endpoint for DeepInfra rerank models. + +### Supported Rerank Models + +| Model Name | Description | +|------------|-------------| +| `deepinfra/Qwen/Qwen3-Reranker-0.6B` | Lightweight rerank model (0.6B parameters) | +| `deepinfra/Qwen/Qwen3-Reranker-4B` | Medium rerank model (4B parameters) | +| `deepinfra/Qwen/Qwen3-Reranker-8B` | Large rerank model (8B parameters) | + +### Usage - LiteLLM Python SDK + + + + +```python +from litellm import rerank +import os + +os.environ["DEEPINFRA_API_KEY"] = "your-api-key" + +response = rerank( + model="deepinfra/Qwen/Qwen3-Reranker-0.6B", + query="What is the capital of France?", + documents=[ + "Paris is the capital of France.", + "London is the capital of the United Kingdom.", + "Berlin is the capital of Germany.", + "Madrid is the capital of Spain.", + "Rome is the capital of Italy." + ] +) +print(response) +``` + + + + +1. Add to config.yaml +```yaml +model_list: + - model_name: Qwen/Qwen3-Reranker-0.6B + litellm_params: + model: deepinfra/Qwen/Qwen3-Reranker-0.6B + api_key: os.environ/DEEPINFRA_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/rerank' \ +-H 'Authorization: Bearer sk-1234' \ +-H 'Content-Type: application/json' \ +-d '{ + "model": "Qwen/Qwen3-Reranker-0.6B", + "query": "What is the capital of France?", + "documents": [ + "Paris is the capital of France.", + "London is the capital of the United Kingdom.", + "Berlin is the capital of Germany.", + "Madrid is the capital of Spain.", + "Rome is the capital of Italy." + ] +}' +``` + + + + +### Supported Cohere Rerank API Params + +| Param | Type | Description | +| ------------------ | ----------- | ----------------------------------------------- | +| `query` | `str` | The query to rerank the documents against | +| `documents` | `list[str]` | The documents to rerank | + + +### Provider-specific parameters +Pass any deepinfra specific parameters as a keyword argument to the rerank function, e.g. + +``` +response = rerank( + model="deepinfra/Qwen/Qwen3-Reranker-0.6B", + query="What is the capital of France?", + documents=[ + "Paris is the capital of France.", + "London is the capital of the United Kingdom.", + "Berlin is the capital of Germany.", + "Madrid is the capital of Spain.", + "Rome is the capital of Italy." + ], + my_custom_param="my_custom_value", # any other deepinfra specific parameters +) +``` + +### Response Format + +```json +{ + "id": "request-id", + "results": [ + { + "index": 0, + "relevance_score": 0.9975274205207825 + }, + { + "index": 1, + "relevance_score": 0.011687257327139378 + } + ], + "meta": { + "billed_units": { + "total_tokens": 427 + }, + "tokens": { + "input_tokens": 427, + "output_tokens": 0 + } + } +} +``` diff --git a/docs/my-website/docs/rerank.md b/docs/my-website/docs/rerank.md index 11dcae777e4..c57eacbb224 100644 --- a/docs/my-website/docs/rerank.md +++ b/docs/my-website/docs/rerank.md @@ -118,4 +118,5 @@ curl http://0.0.0.0:4000/rerank \ | AWS Bedrock| [Usage](../docs/providers/bedrock#rerank-api) | | HuggingFace| [Usage](../docs/providers/huggingface_rerank) | | Infinity| [Usage](../docs/providers/infinity) | -| vLLM| [Usage](../docs/providers/vllm#rerank-endpoint) | \ No newline at end of file +| vLLM| [Usage](../docs/providers/vllm#rerank-endpoint) | +| DeepInfra| [Usage](../docs/providers/deepinfra#rerank-endpoint) | \ No newline at end of file