Package version:

Interface AzureOpenAIParameters

Specifies the parameters for connecting to the Azure OpenAI resource.

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

Properties

apiKey?: string

API key of the designated Azure OpenAI resource.

The user-assigned managed identity used for outbound connections.

deploymentId?: string

ID of the Azure OpenAI 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 of the Azure OpenAI resource.