VoyageAI Reranker
Voyage AI provides cutting-edge embedding and rerankers. This reranker uses the VoyageAI API to rerank the search results. You can use this reranker by passingVoyageAIReranker() to the rerank() method. Note that you’ll either need to set the VOYAGE_API_KEY environment variable or pass the api_key argument to use this reranker.
Note: Supported query types – Hybrid, Vector, and FTS.
Accepted Arguments
| Argument | Type | Default | Description |
|---|---|---|---|
model_name | str | None | The name of the reranker model to use. Available models are: rerank-2, rerank-2-lite |
column | str | "text" | The name of the column to use as input to the cross encoder model. |
top_n | str | None | The number of results to return. If None, will return all results. |
api_key | str | None | The API key for the Voyage AI API. If not provided, the VOYAGE_API_KEY environment variable is used. |
return_score | str | "relevance" | Options are “relevance” or “all”. The type of score to return. If “relevance”, will return only the `_relevance_score. If “all” is supported, will return relevance score along with the vector and/or fts scores depending on query type |
truncation | bool | None | Whether to truncate the input to satisfy the “context length limit” on the query and the documents. |
Supported Scores for each query type
You can specify the type of scores you want the reranker to return. The following are the supported scores for each query type:Hybrid Search
return_score | Status | Description |
|---|---|---|
relevance | ✅ Supported | Returns only have the _relevance_score column |
all | ❌ Not Supported | Returns have vector(_distance) and FTS(score) along with Hybrid Search score(_relevance_score) |
Vector Search
return_score | Status | Description |
|---|---|---|
relevance | ✅ Supported | Returns only have the _relevance_score column |
all | ✅ Supported | Returns have vector(_distance) along with Hybrid Search score(_relevance_score) |
FTS Search
return_score | Status | Description |
|---|---|---|
relevance | ✅ Supported | Returns only have the _relevance_score column |
all | ✅ Supported | Returns have FTS(score) along with Hybrid Search score(_relevance_score) |