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

OptionalapiKey

apiKey?: string

API key to use when making requests to Azure OpenAI.

OptionalazureOpenAIApiDeploymentName

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/

OptionalazureOpenAIApiKey

azureOpenAIApiKey?: string

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

OptionalazureOpenAIApiVersion

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

OptionalazureOpenAIEmbeddingsApiDeploymentName

azureOpenAIEmbeddingsApiDeploymentName?: string

Deprecated

Use "azureOpenAIApiDeploymentName" instead.

OptionalazureOpenAIEndpoint

azureOpenAIEndpoint?: string

Endpoint to use when making requests to Azure OpenAI

Optionalcredentials

credentials?: KeyCredential | TokenCredential

OptionalopenAIApiKey

openAIApiKey?: string

Settings

Member Visibility

On This Page

Properties