VoyageAIEmbeddings

class langchain_voyageai.embeddings.VoyageAIEmbeddings

Bases: BaseModel, Embeddings

VoyageAIEmbeddings embedding model.

Example

from langchain_voyageai import VoyageAIEmbeddings

model = VoyageAIEmbeddings()

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param batch_size: int [Required]

param model: str [Required]

param output_dimension: Literal[256, 512, 1024, 2048] | None = None

param show_progress_bar: bool = False

param truncation: bool = True

param voyage_api_key: SecretStr [Optional] (alias 'api_key')

async aembed_documents(texts: List[str]) → List[List[float]]

Asynchronous Embed search docs.

Parameters:

texts (List[str]) – List of text to embed.

Returns:

List of embeddings.

Return type:

List[List[float]]

async aembed_query(text: str) → List[float]

Asynchronous Embed query text.

Parameters:

text (str) – Text to embed.

Returns:

Embedding.

Return type:

List[float]

embed_documents(texts: List[str]) → List[List[float]]

Embed search docs.

Parameters:

texts (List[str])

Return type:

List[List[float]]

embed_query(text: str) → List[float]

Embed query text.

Parameters:

text (str)

Return type:

List[float]