azure_text_embedding Module

Azure Text Embedding class.

Note: This class is marked as 'experimental' and may change in the future.

Initialize an AzureTextEmbedding service.

service_id: The service ID. (Optional) api_key: The optional api key. If provided, will override the value in the

env vars or .env file.

deployment_name: The optional deployment. If provided, will override the value (text_deployment_name) in the env vars or .env file.

endpoint: The optional deployment endpoint. If provided will override the value in the env vars or .env file.

base_url: The optional deployment base_url. If provided will override the value in the env vars or .env file.

api_version: The optional deployment api version. If provided will override the value in the env vars or .env file.

ad_token: The Azure AD token for authentication. (Optional) ad_token_provider: Whether to use Azure Active Directory authentication.

(Optional) The default value is False.

token_endpoint: The Azure AD token endpoint. (Optional) default_headers: The default headers mapping of string keys to

string values for HTTP requests. (Optional)

async_client (Optional[AsyncAzureOpenAI]): An existing client to use. (Optional) env_file_path (str | None): Use the environment settings file as a fallback to

environment variables. (Optional)