Interface AzureOpenAIInput

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

Implemented by

Properties

apiKey? azureOpenAIApiDeploymentName? azureOpenAIApiKey? azureOpenAIApiVersion? azureOpenAIEmbeddingsApiDeploymentName? azureOpenAIEndpoint? credentials? openAIApiKey?

Properties

Optional apiKey

apiKey?: string

API key to use when making requests to Azure OpenAI.

Optional azureOpenAIApiDeploymentName

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/

Optional azureOpenAIApiKey

azureOpenAIApiKey?: string

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

Optional azureOpenAIApiVersion

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

Optional azureOpenAIEmbeddingsApiDeploymentName

azureOpenAIEmbeddingsApiDeploymentName?: string

⚠️ Deprecated ⚠️

Use "azureOpenAIApiDeploymentName" instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Optional azureOpenAIEndpoint

azureOpenAIEndpoint?: string

Endpoint to use when making requests to Azure OpenAI

Optional credentials

credentials?: KeyCredential | TokenCredential

Optional openAIApiKey

openAIApiKey?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc