Interface AzureOpenAIChatInput

interface AzureOpenAIChatInput {
    apiKey?: string;
    audio?: ChatCompletionAudioParam;
    azureADTokenProvider?: (() => Promise<string>);
    azureOpenAIApiCompletionsDeploymentName?: string;
    azureOpenAIApiDeploymentName?: string;
    azureOpenAIApiEmbeddingsDeploymentName?: string;
    azureOpenAIApiInstanceName?: string;
    azureOpenAIApiKey?: string;
    azureOpenAIApiVersion?: string;
    azureOpenAIBasePath?: string;
    azureOpenAIEndpoint?: string;
    deploymentName?: string;
    frequencyPenalty: number;
    logitBias?: Record<string, number>;
    logprobs?: boolean;
    maxCompletionTokens?: number;
    maxTokens?: number;
    modalities?: ChatCompletionModality[];
    model: OpenAIChatModelId;
    modelKwargs?: Record<string, any>;
    modelName: string;
    n: number;
    openAIApiKey?: string;
    openAIApiVersion?: string;
    openAIBasePath?: string;
    prefixMessages?: ChatCompletionMessageParam[];
    presencePenalty: number;
    promptCacheKey?: string;
    reasoning?: Reasoning;
    reasoningEffort?: ReasoningEffort;
    service_tier?:
        | null
        | "auto"
        | "default"
        | "flex"
        | "scale"
        | "priority";
    stop?: string[];
    stopSequences?: string[];
    streamUsage?: boolean;
    streaming: boolean;
    supportsStrictToolCalling?: boolean;
    temperature: number;
    timeout?: number;
    topLogprobs?: number;
    topP: number;
    user?: string;
    verbosity?: OpenAIVerbosityParam;
    zdrEnabled?: boolean;
}

Hierarchy (view full)

Properties

apiKey? audio? azureADTokenProvider? azureOpenAIApiCompletionsDeploymentName? azureOpenAIApiDeploymentName? azureOpenAIApiEmbeddingsDeploymentName? azureOpenAIApiInstanceName? azureOpenAIApiKey? azureOpenAIApiVersion? azureOpenAIBasePath? azureOpenAIEndpoint? deploymentName? frequencyPenalty logitBias? logprobs? maxCompletionTokens? maxTokens? modalities? model modelKwargs? modelName n openAIApiKey? openAIApiVersion? openAIBasePath? prefixMessages? presencePenalty promptCacheKey? reasoning? reasoningEffort? service_tier? stop? stopSequences? streamUsage? streaming supportsStrictToolCalling? temperature timeout? topLogprobs? topP user? verbosity? zdrEnabled?

Properties

OptionalapiKey

apiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable.

Optionalaudio

audio?: ChatCompletionAudioParam

Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

OptionalazureADTokenProvider

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.

OptionalazureOpenAIApiCompletionsDeploymentName

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/

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/

OptionalazureOpenAIApiEmbeddingsDeploymentName

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/

OptionalazureOpenAIApiInstanceName

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

OptionalazureOpenAIApiKey

azureOpenAIApiKey?: string

API key to use when making requests to Azure OpenAI.

OptionalazureOpenAIApiVersion

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

OptionalazureOpenAIBasePath

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

OptionalazureOpenAIEndpoint

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

OptionaldeploymentName

deploymentName?: string

frequencyPenalty

frequencyPenalty: number

Penalizes repeated tokens according to frequency

OptionallogitBias

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

Optionallogprobs

logprobs?: boolean

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

OptionalmaxCompletionTokens

maxCompletionTokens?: number

Maximum number of tokens to generate in the completion. -1 returns as many tokens as possible given the prompt and the model's maximum context size. Alias for maxTokens for reasoning models.

OptionalmaxTokens

maxTokens?: number

Maximum number of tokens to generate in the completion. -1 returns as many tokens as possible given the prompt and the model's maximum context size.

Optionalmodalities

modalities?: ChatCompletionModality[]

Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:

["text"]

The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use:

["text", "audio"]

model

model: OpenAIChatModelId

Model name to use

OptionalmodelKwargs

modelKwargs?: Record<string, any>

Holds any additional parameters that are valid to pass to openai.createCompletion that are not explicitly specified on this class.

modelName

modelName: string

Model name to use Alias for model

Deprecated

Use "model" instead.

n

n: number

Number of completions to generate for each prompt

OptionalopenAIApiKey

openAIApiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable. Alias for apiKey

OptionalopenAIApiVersion

openAIApiVersion?: string

OptionalopenAIBasePath

openAIBasePath?: string

OptionalprefixMessages

prefixMessages?: ChatCompletionMessageParam[]

ChatGPT messages to pass as a prefix to the prompt

presencePenalty

presencePenalty: number

Penalizes repeated tokens

OptionalpromptCacheKey

promptCacheKey?: string

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

Optionalreasoning

reasoning?: Reasoning

Options for reasoning models.

Note that some options, like reasoning summaries, are only available when using the responses API. This option is ignored when not using a reasoning model.

OptionalreasoningEffort

reasoningEffort?: ReasoningEffort

Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Deprecated

Use reasoning instead.

Optionalservice_tier

service_tier?:
    | null
    | "auto"
    | "default"
    | "flex"
    | "scale"
    | "priority"

Service tier to use for this request. Can be "auto", "default", or "flex" or "priority". Specifies the service tier for prioritization and latency optimization.

Optionalstop

stop?: string[]

List of stop words to use when generating Alias for stopSequences

OptionalstopSequences

stopSequences?: string[]

List of stop words to use when generating

OptionalstreamUsage

streamUsage?: boolean

Whether or not to include token usage data in streamed chunks.

Default

true

streaming

streaming: boolean

Whether to stream the results or not. Enabling disables tokenUsage reporting

OptionalsupportsStrictToolCalling

supportsStrictToolCalling?: boolean

Whether the model supports the strict argument when passing in tools. If undefined the strict argument will not be passed to OpenAI.

temperature

temperature: number

Sampling temperature to use

Optionaltimeout

timeout?: number

Timeout to use when making requests to OpenAI.

OptionaltopLogprobs

topLogprobs?: number

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

topP

topP: number

Total probability mass of tokens to consider at each step

Optionaluser

user?: string

Unique string identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Optionalverbosity

verbosity?: OpenAIVerbosityParam

The verbosity of the model's response.

OptionalzdrEnabled

zdrEnabled?: boolean

Should be set to true in tenancies with Zero Data Retention

See

https://platform.openai.com/docs/guides/your-data

Default

false

Settings

Member Visibility

On This Page

Properties