Azure OpenAI
Parameter reference for AzureOpenAIEmbedder: deployment, API version, endpoint, and batching options.
Azure OpenAI Embedder embeds documents using Azure OpenAI.
Parameters
| Parameter | Type | Description | Default |
|---|---|---|---|
id | str | The model ID that matches your deployed model | "text-embedding-3-small" |
dimensions | Optional[int] | Output dimensions of the embedding | None (resolved to 1536 for text-embedding-3 models) |
encoding_format | Literal["float", "base64"] | Format of the embedding output | "float" |
user | Optional[str] | A unique identifier representing your end-user | None |
api_key | Optional[str] | Azure OpenAI API key | Environment variable AZURE_EMBEDDER_OPENAI_API_KEY |
api_version | str | Azure OpenAI API version | Environment variable AZURE_EMBEDDER_OPENAI_API_VERSION or "2024-10-21" |
azure_endpoint | Optional[str] | Azure OpenAI endpoint URL | Environment variable AZURE_EMBEDDER_OPENAI_ENDPOINT |
azure_deployment | Optional[str] | Azure OpenAI deployment name | Environment variable AZURE_EMBEDDER_DEPLOYMENT |
base_url | Optional[str] | Base URL for API requests | None |
azure_ad_token | Optional[str] | Azure AD token for authentication | None |
azure_ad_token_provider | Optional[Any] | Provider for Azure AD tokens | None |
organization | Optional[str] | Organization ID for API requests | None |
request_params | Optional[Dict[str, Any]] | Additional parameters for embedding requests | None |
client_params | Optional[Dict[str, Any]] | Additional parameters for client initialization | None |
openai_client | Optional[AzureOpenAIClient] | Pre-configured Azure OpenAI client | None |
async_client | Optional[AsyncAzureOpenAIClient] | Pre-configured async Azure OpenAI client | None |
enable_batch | bool | Embed multiple texts per API call when adding content to vector databases | False |
batch_size | int | Number of texts per batch when enable_batch is True | 100 |