interface AzureOpenAIInput {
    azureADTokenProvider?: (() => Promise<string>);
    azureOpenAIApiCompletionsDeploymentName?: string;
    azureOpenAIApiDeploymentName?: string;
    azureOpenAIApiEmbeddingsDeploymentName?: string;
    azureOpenAIApiInstanceName?: string;
    azureOpenAIApiKey?: string;
    azureOpenAIApiVersion?: string;
    azureOpenAIBasePath?: string;
}

Implemented by

Properties

azureADTokenProvider?: (() => Promise<string>)

Type declaration

    • (): Promise<string>
    • Returns Promise<string>

azureOpenAIApiCompletionsDeploymentName?: string

Azure OpenAI API deployment name to use for completions when making requests to Azure OpenAI. Completions are only available for gpt-3.5-turbo and text-davinci-003 deployments. This is the name of the deployment you created in the Azure portal. This will fallback to azureOpenAIApiDeploymentName if not provided. e.g. "my-openai-deployment" this will be used in the endpoint URL: https://{InstanceName}.openai.azure.com/openai/deployments/my-openai-deployment/

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/

azureOpenAIApiEmbeddingsDeploymentName?: string

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

azureOpenAIApiInstanceName?: string

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

azureOpenAIApiKey?: string

API key to use when making requests to Azure OpenAI.

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

azureOpenAIBasePath?: string

Custom endpoint for Azure OpenAI API. This is useful in case you have a deployment in another region. e.g. setting this value to "https://westeurope.api.cognitive.microsoft.com/openai/deployments" will be result in the endpoint URL: https://westeurope.api.cognitive.microsoft.com/openai/deployments/{DeploymentName}/

Generated using TypeDoc