milvus-logo
LFAI
< Docs
  • Python
    • EmbeddingModels

VoyageEmbeddingFunction

VoyageEmbeddingFunction is a class in pymilvus that handles encoding text into embeddings using Voyage models to support embedding retrieval in Milvus.

pymilvus.model.dense.VoyageEmbeddingFunction

Constructor

Constructs an VoyageEmbeddingFunction for common use cases.

VoyageEmbeddingFunction(
    model_name: str = "voyage-2",
    api_key: Optional[str] = None,
    **kwargs
)

PARAMETERS:

  • model_name (string)

    The name of the Voyage model to use for encoding. You can specify any of the available Voyage model names, for example, voyage-law-2, voyage-code-2, etc. If you leave this parameter unspecified, voyage-2 will be used. For a list of available models, refer to Voyage official documentation.

  • api_key (string)

    The API key for accessing the Voyage API. For information on how to create an API key, refer to API Key and Python Client.

  • kwargs

    Allows additional keyword arguments to be passed to the model initialization. For more information, refer to Python API.

Examples

from pymilvus.model.dense import VoyageEmbeddingFunction

voyage_ef = VoyageEmbeddingFunction(
    model_name="voyage-lite-02-instruct", # Defaults to `voyage-2`
    api_key='YOUR_API_KEY' # Replace with your own Voyage API key
)