Package version:

Interface AzureOpenAIParameters

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

interface AzureOpenAIParameters {
    apiKey?: string;
    authIdentity?: SearchIndexerDataIdentity;
    deploymentId?: string;
    modelName?: string;
    resourceUrl?: string;
}

Properties

apiKey?: string

API key for the designated Azure Open AI resource.

The user-assigned managed identity used for outbound connections.

deploymentId?: string

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

modelName?: string

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

resourceUrl?: string

The resource uri for your Azure Open AI resource.