Interface BaseChatOpenAIFields

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.

Deprecated

Use callbacks instead

Whether to disable streaming.

If streaming is bypassed, then stream() will defer to invoke().

• If true, will always bypass streaming case.
• If false (default), will always use streaming case if available.

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.

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

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.

Model name to use Alias for model

Deprecated

Use "model" instead.

Number of completions to generate for each prompt

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

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.

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.

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.

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 or not to include token usage data in streamed chunks.

Default

true
Copy

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

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

See

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

Default

false
Copy