milvus-logo
LFAI
< Docs
  • Python
    • Rerankers

CohereRerankFunction

CohereRerankFunction is a class in milvus_model that takes a query and document as input and directly returns a similarity score instead of embeddings. This functionality uses the underlying Cohere reranking model.

pymilvus.model.reranker.CohereRerankFunction

Constructor

Constructs a CohereRerankFunction for common use cases.

CohereRerankFunction(
    model_name: str = "rerank-english-v2.0",
    api_key: Optional[str] = None
)

PARAMETERS:

  • model_name (string)

    The name of the model to use. You can specify any of the available Cohere reranker model names, for example, rerank-english-v3.0, rerank-multilingual-v3.0, etc. If you leave this parameter unspecified, rerank-english-v2.0 will be used. For a list of available models, refer to Rerank.

  • api_key (string)

    The API key for accessing the Cohere API. For information on how to create an API key, refer to Cohere dashboard.

Examples

from pymilvus.model.reranker import CohereRerankFunction

# Define the rerank function
cohere_rf = CohereRerankFunction(
    model_name="rerank-english-v3.0",  # Specify the model name. Defaults to `rerank-english-v2.0`.
    api_key=COHERE_API_KEY # Replace with your Cohere API key
)