langchain.js
    Preparing search index...

    Interface AzureOpenAIInput

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

    Hierarchy (View Summary)

    Index

    Properties

    azureADTokenProvider? azureOpenAIApiCompletionsDeploymentName? azureOpenAIApiDeploymentName? azureOpenAIApiEmbeddingsDeploymentName? azureOpenAIApiInstanceName? azureOpenAIApiKey? azureOpenAIApiVersion? azureOpenAIBasePath? azureOpenAIEndpoint?

    Properties

    azureADTokenProvider?: () => Promise<string>

    A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.

    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 base url 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}/

    azureOpenAIEndpoint?: 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/" will be result in the endpoint URL: https://westeurope.api.cognitive.microsoft.com/openai/deployments/{DeploymentName}/

    Settings

    Member Visibility

    On This Page

    Properties