AzureOpenAIChatInput

Whether to include the raw OpenAI response in the output message's "additional_kwargs" field. Currently in experimental beta.

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

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

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

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/

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/

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/

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

API key to use when making requests to Azure OpenAI.

API version to use when making requests to Azure OpenAI.

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

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

Penalizes repeated tokens according to frequency

Dictionary used to adjust the probability of specific tokens being generated

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.

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.

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.

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 name to use

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

Number of completions to generate for each prompt

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

ChatGPT messages to pass as a prefix to the prompt

Penalizes repeated tokens

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

Used by OpenAI to set cache retention time

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.

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

List of stop words to use when generating Alias for stopSequences

List of stop words to use when generating

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

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

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

Sampling temperature to use

Timeout to use when making requests to OpenAI.

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.

Total probability mass of tokens to consider at each step

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

The verbosity of the model's response.

Should be set to true in tenancies with Zero Data Retention