milvus-logo
LFAI
< Docs
  • Python
    • EmbeddingModels

JinaEmbeddingFunction

JinaEmbeddingFunction is a class in pymilvus that handles encoding text into embeddings using Jina AI embedding models to support embedding retrieval in Milvus.

pymilvus.model.dense.JinaEmbeddingFunction

Constructor

Constructs a JinaEmbeddingFunction for common use cases.

JinaEmbeddingFunction(
    model_name: str = "jina-embeddings-v2-base-en",
    api_key: Optional[str] = None,
    **kwargs
)

PARAMETERS:

  • model_name (string)

    The name of the Jina AI embedding model to use for encoding. You can specify any of the available Jina AI embedding model names, for example, jina-embeddings-v2-base-en, jina-embeddings-v2-small-en, etc. If you leave this parameter unspecified, jina-embeddings-v2-base-en will be used. For a list of available models, refer to Jina Embeddings.

  • api_key (string)

    The API key for accessing the Jina AI API.

  • kwargs

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

Examples

from pymilvus.model.dense import JinaEmbeddingFunction

jina_ef = JinaEmbeddingFunction(
    model_name="jina-embeddings-v2-base-en", # Defaults to `jina-embeddings-v2-base-en`
    api_key="YOUR_JINAAI_API_KEY" # Provide your Jina AI API key
)
Feedback

Was this page helpful?