AzureOpenAIParameters interface

Contains the parameters specific to using an Azure Open AI service for vectorization at query time.

Properties

apiKey

API key for the designated Azure Open AI resource.

authIdentity

The user-assigned managed identity used for outbound connections.

deploymentId

ID of your Azure Open AI model deployment on the designated resource.

modelName

The name of the embedding model that is deployed at the provided deploymentId path.

resourceUrl

The resource uri for your Azure Open AI resource.

Property Details

apiKey

API key for the designated Azure Open AI resource.

apiKey?: string

Property Value

string

authIdentity

The user-assigned managed identity used for outbound connections.

authIdentity?: SearchIndexerDataIdentity

Property Value

deploymentId

ID of your Azure Open AI model deployment on the designated resource.

deploymentId?: string

Property Value

string

modelName

The name of the embedding model that is deployed at the provided deploymentId path.

modelName?: string

Property Value

string

resourceUrl

The resource uri for your Azure Open AI resource.

resourceUrl?: string

Property Value

string