voyageai_reranker¶

The voyageai reranker module is a reranker from VoyageAI. It supports powerful and fast reranker for passage retrieval.

Before Usage¶

At first, you need to get the VoyageAI API key from here.

Next, you can set your VoyageAI API key in the environment variable “VOYAGE_API_KEY”.

export VOYAGE_API_KEY=your_voyageai_api_key

Or, you can set your VoyageAI API key in the config.yaml file directly.

- module_type: voyageai_reranker
  api_key: your_voyageai_api_key

model : The type of model you want to use for reranking. Default is “rerank-2” and you can change it to “rerank-2-lite”
api_key : The voyageai api key.
truncation : Whether to truncate the input to satisfy the ‘context length limit’ on the query and the documents. Default is True.

- module_type: voyageai_reranker
  api_key: your_voyageai_api_key
  model: rerank-2

You can see the supported model names here.

Model Name
rerank-2
rerank-2-lite