WeaviateEx.API.RerankerConfig (WeaviateEx v0.7.4)

View Source

Reranker configuration for collections.

Configure reranking models to improve search result relevance. Rerankers re-score search results using more sophisticated models to improve ranking quality.

Built-in Providers

Custom Providers

Examples

# Cohere reranker
config = RerankerConfig.cohere("rerank-english-v3.0")
Collections.create("Article", %{
  properties: [...],
  reranker_config: config
})

# Custom reranker
config = RerankerConfig.custom("my-reranker",
  api_endpoint: "https://reranker.example.com",
  model: "rerank-v1"
)

Summary

Types

config()

Functions

cohere(model \\ "rerank-english-v2.0", opts \\ [])

Create a Cohere reranker configuration.

contextualai(model \\ nil, opts \\ [])

Create a Contextual AI reranker configuration.

custom(name, opts)

Create a custom reranker configuration for unlisted providers.

jinaai(model, opts \\ [])

Create a Jina AI reranker configuration.

none()

Disable reranking.

nvidia(model \\ nil, opts \\ [])

Create an NVIDIA reranker configuration.

transformers(opts \\ [])

Create a local transformers reranker configuration.

voyageai(model, opts \\ [])

Create a Voyage AI reranker configuration.

Types

config()

@type config() :: %{required(String.t()) => map()}

Functions

cohere(model \\ "rerank-english-v2.0", opts \\ [])

@spec cohere(
  String.t(),
  keyword()
) :: config()

Create a Cohere reranker configuration.

Arguments

  • model - Cohere model name (default: "rerank-english-v2.0")

Options

  • :base_url - Custom API endpoint URL

Examples

RerankerConfig.cohere()
RerankerConfig.cohere("rerank-english-v3.0")
RerankerConfig.cohere("rerank-multilingual-v3.0", base_url: "https://api.cohere.ai")

contextualai(model \\ nil, opts \\ [])

@spec contextualai(
  String.t() | nil,
  keyword()
) :: config()

Create a Contextual AI reranker configuration.

Arguments

  • model - Contextual AI model name (optional)

Options

  • :base_url - Custom API endpoint URL
  • :instruction - Instruction for the reranker

Examples

RerankerConfig.contextualai()
RerankerConfig.contextualai("ctxai-rerank-v1")
RerankerConfig.contextualai("ctxai-rerank", base_url: "https://api.contextual.ai", instruction: "Rank by relevance")

custom(name, opts)

@spec custom(
  String.t(),
  keyword()
) :: config()

Create a custom reranker configuration for unlisted providers.

All options are passed through with automatic snake_case to camelCase conversion.

Arguments

  • name - Identifier for the custom provider
  • opts - Provider configuration options

Common Options

  • :api_endpoint - API endpoint URL
  • :model - Model identifier
  • :base_url - Base URL for the API

Examples

RerankerConfig.custom("my-reranker",
  api_endpoint: "https://reranker.example.com",
  model: "rerank-v1"
)

RerankerConfig.custom("local-reranker",
  api_endpoint: "http://localhost:9000",
  max_tokens: 512,
  batch_size: 32
)

jinaai(model, opts \\ [])

@spec jinaai(
  String.t(),
  keyword()
) :: config()

Create a Jina AI reranker configuration.

Arguments

  • model - Jina AI model name

Options

  • :base_url - Custom API endpoint URL

Examples

RerankerConfig.jinaai("jina-reranker-v1-base-en")
RerankerConfig.jinaai("jina-reranker-v1-turbo-en")

none()

@spec none() :: config()

Disable reranking.

Examples

RerankerConfig.none()

nvidia(model \\ nil, opts \\ [])

@spec nvidia(
  String.t() | nil,
  keyword()
) :: config()

Create an NVIDIA reranker configuration.

Arguments

  • model - NVIDIA model name (optional)

Options

  • :base_url - Custom API endpoint URL

Examples

RerankerConfig.nvidia()
RerankerConfig.nvidia("nvidia-nemo-retriever-qa-mistral-4b-instruct")
RerankerConfig.nvidia("nvidia-rerank", base_url: "https://api.nvidia.com")

transformers(opts \\ [])

@spec transformers(keyword()) :: config()

Create a local transformers reranker configuration.

Uses a locally deployed transformers model for reranking.

Options

  • :query_key - Key for the query in the input
  • :passage_key - Key for the passage in the input
  • :inference_url - URL of the inference service

Examples

RerankerConfig.transformers()
RerankerConfig.transformers(inference_url: "http://localhost:8080")

voyageai(model, opts \\ [])

@spec voyageai(
  String.t(),
  keyword()
) :: config()

Create a Voyage AI reranker configuration.

Arguments

  • model - Voyage AI model name

Options

  • :base_url - Custom API endpoint URL
  • :truncation - Truncation mode

Examples

RerankerConfig.voyageai("rerank-1")
RerankerConfig.voyageai("rerank-lite-1", base_url: "https://api.voyageai.com")