interface AzureOpenAIInput {
    apiKey?: string;
    azureOpenAIApiDeploymentName?: string;
    azureOpenAIApiKey?: string;
    azureOpenAIApiVersion?: string;
    azureOpenAIEmbeddingsApiDeploymentName?: string;
    azureOpenAIEndpoint?: string;
    credentials?: KeyCredential | TokenCredential;
    openAIApiKey?: string;
}

Implemented by

Properties

apiKey?: string

API key to use when making requests to Azure OpenAI.

azureOpenAIApiDeploymentName?: string

Azure OpenAI API deployment name to use for completions when making requests to Azure OpenAI. This is the name of the deployment you created in the Azure portal. e.g. "my-openai-deployment" this will be used in the endpoint URL: https://{InstanceName}.openai.azure.com/openai/deployments/my-openai-deployment/

azureOpenAIApiKey?: string

API key to use when making requests to Azure OpenAI. Alias for apiKey

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

azureOpenAIEmbeddingsApiDeploymentName?: string

Use "azureOpenAIApiDeploymentName" instead.

azureOpenAIEndpoint?: string

Endpoint to use when making requests to Azure OpenAI

credentials?: KeyCredential | TokenCredential
openAIApiKey?: string