Common Configuration Parameters
All rerankers share these common configuration parameters:| Parameter | Description | Type | Default |
|---|---|---|---|
provider | Reranker provider name | str | Required |
top_k | Maximum number of results to return after reranking | int | None |
api_key | API key for the reranker service | str | None |
Provider-Specific Configuration
Zero Entropy
| Parameter | Description | Type | Default |
|---|---|---|---|
model | Model to use: zerank-1 or zerank-1-small | str | "zerank-1" |
api_key | Zero Entropy API key | str | None |
Cohere
| Parameter | Description | Type | Default |
|---|---|---|---|
model | Cohere rerank model | str | "rerank-english-v3.0" |
api_key | Cohere API key | str | None |
return_documents | Whether to return document texts in response | bool | False |
max_chunks_per_doc | Maximum chunks per document | int | None |
Sentence Transformer
| Parameter | Description | Type | Default |
|---|---|---|---|
model | HuggingFace cross-encoder model name | str | "cross-encoder/ms-marco-MiniLM-L-6-v2" |
device | Device to run model on (cpu, cuda, etc.) | str | None |
batch_size | Batch size for processing | int | 32 |
show_progress_bar | Show progress during processing | bool | False |
Hugging Face
| Parameter | Description | Type | Default |
|---|---|---|---|
model | HuggingFace reranker model name | str | "BAAI/bge-reranker-large" |
api_key | HuggingFace API token | str | None |
device | Device to run model on (cpu, cuda, etc.) | str | None |
LLM-based
| Parameter | Description | Type | Default |
|---|---|---|---|
model | LLM model to use for scoring | str | "gpt-4o-mini" |
provider | LLM provider (openai, anthropic, etc.) | str | "openai" |
api_key | API key for LLM provider | str | None |
temperature | Temperature for LLM generation | float | 0.0 |
max_tokens | Maximum tokens for LLM response | int | 100 |
scoring_prompt | Custom prompt template for scoring | str | Default scoring prompt |
LLM Reranker
| Parameter | Description | Type | Default |
|---|---|---|---|
llm.provider | LLM provider for reranking | str | Required |
llm.config | LLM configuration object | dict | Required |
top_n | Number of results to return | int | None |
Environment Variables
You can set API keys using environment variables:ZERO_ENTROPY_API_KEY- Zero Entropy API keyCOHERE_API_KEY- Cohere API keyHUGGINGFACE_API_KEY- HuggingFace API tokenOPENAI_API_KEY- OpenAI API key (for LLM-based reranker)ANTHROPIC_API_KEY- Anthropic API key (for LLM-based reranker)
Basic Configuration Example
Python