AzureOpenAITextEmbedder Parameters

Check the parameters you can specify for AzureOpenAITextEmbedder.

YAML Init Parameters

These are the parameters you can specify in pipeline YAML:

ParameterTypePossible valuesDescription
'azure_endpoint'StringNoneThe endpoint of the deployed model.
Optional.
'api_version'StringDefault: "2023-05-15"The version of the API to use.
Optional.
'azure_deployment'StringDefault: "text-embedding-ada-002"The deployment of the model, usually matches the model name. Required.
'dimensions'IntegerDefault NoneThe number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
Optional.
'api_key'SecretThe API key used for authentication.
Optional.
'azure_ad_token'SecretMicrosoft Entra ID token. See Microsoft's official Entra ID documentation for more information. (Used to be called Azure Active Directory.)
Optional.
'organization'StringDefault: NoneThe Organization ID. See OpenAI's production best practices for more information.
Optional.
'prefix'StringDefault: "" (empty string)A string to add at the beginning of each text.
Optional.
'suffix'StringDefault: "" (empty string)A string to add at the end of each text.
Optional.
max_retriesIntegerDefault: 5The maximum number of times the component tries to make a request.
Required.
timeoutIntegerDefault: 30The timeout in seconds for the component.
Required.

REST API Runtime Parameters

There are no runtime parameters you can pass to this component when making a request to the Search REST API endpoint.