Package com.redis.vl.utils.rerank

Class VoyageAIReranker

java.lang.Object
com.redis.vl.utils.rerank.BaseReranker
com.redis.vl.utils.rerank.VoyageAIReranker
public class VoyageAIReranker extends BaseReranker
Reranker that uses VoyageAI's Rerank API to rerank documents based on query relevance.

This reranker interacts with VoyageAI's /v1/rerank API, requiring an API key for authentication. The API key can be provided directly in the apiConfig Map or through the VOYAGE_API_KEY environment variable.

Users must obtain an API key from VoyageAI Dashboard.

Example usage: 


 // Initialize with API key
 Map<String, String> apiConfig = Map.of("api_key", "your-api-key");
 VoyageAIReranker reranker = VoyageAIReranker.builder()
     .model("rerank-lite-1")
     .apiConfig(apiConfig)
     .limit(3)
     .build();

 // Rerank string documents
 List<String> docs = Arrays.asList("doc1", "doc2", "doc3");
 RerankResult result = reranker.rank("query", docs);
See Also:

  • Method Details

    • rank

      public RerankResult rank(String query, List<?> docs)
      Rerank documents based on query relevance using VoyageAI's Rerank API.
      Specified by:
      rank in class BaseReranker
      Parameters:
      query - The search query
      docs - List of documents (must be List<String>)
      Returns:
      RerankResult with reranked documents and relevance scores
      Throws:
      IllegalArgumentException - if query or docs are invalid

    • rank

      public RerankResult rank(String query, List<?> docs, Map<String,Object> kwargs)
      Rerank documents based on query relevance using VoyageAI's Rerank API with runtime parameter overrides.
      Parameters:
      query - The search query
      docs - List of documents (must be List<String>)
      kwargs - Optional parameters to override defaults (limit, return_score, truncation)
      Returns:
      RerankResult with reranked documents and relevance scores
      Throws:
      IllegalArgumentException - if query or docs are invalid