VoyageAI

Parameter reference for VoyageAIEmbedder, which embeds text with VoyageAI embedding models via the voyageai client.

VoyageAI Embedder embeds documents using VoyageAI's embedding models, which are specifically designed for high-performance text embeddings.

Parameters

ParameterTypeDescriptionDefault
idstrThe model ID to use for embeddings"voyage-2"
dimensionsintOutput dimensions of the embedding1024
request_paramsOptional[Dict[str, Any]]Additional parameters for embedding requestsNone
api_keyOptional[str]VoyageAI API key; when unset, the VoyageAI SDK reads VOYAGE_API_KEYNone
base_urlstrDeclared field, currently not forwarded to either client; configure a custom endpoint with client_params or an injected client"https://api.voyageai.com/v1/embeddings"
max_retriesOptional[int]Maximum number of retry attemptsNone
timeoutOptional[float]Request timeout in secondsNone
client_paramsOptional[Dict[str, Any]]Additional parameters for client initializationNone
voyage_clientOptional[Client]Pre-configured VoyageAI clientNone
async_clientOptional[AsyncClient]Pre-configured async VoyageAI clientNone
enable_batchboolEmbed multiple texts per API call when adding content to vector databasesFalse
batch_sizeintNumber of texts per batch when enable_batch is True100
dimensions records the expected vector width; it is not forwarded and does not resize embeddings. For models that support configurable widths, set request_params={"output_dimension": ...} and matching dimensions. A custom SDK endpoint can be supplied with client_params={"base_url": "https://your-host/v1"} or an injected client.