CreateChatCompletionRequest class

Request object for the Create chat completion endpoint.

Annotations

• @freezed

Constructors

CreateChatCompletionRequest.new({@_ChatCompletionModelConverter() required ChatCompletionModel model, required List<ChatCompletionMessage> messages, @JsonKey(includeIfNull: false) bool? store, @JsonKey(name: 'reasoning_effort', includeIfNull: false, unknownEnumValue: JsonKey.nullForUndefinedEnumValue) ReasoningEffort? reasoningEffort, @JsonKey(includeIfNull: false) Map<String, String>? metadata, @JsonKey(name: 'frequency_penalty', includeIfNull: false) double? frequencyPenalty, @JsonKey(name: 'logit_bias', includeIfNull: false) Map<String, int>? logitBias, @JsonKey(includeIfNull: false) bool? logprobs, @JsonKey(name: 'top_logprobs', includeIfNull: false) int? topLogprobs, @JsonKey(name: 'max_tokens', includeIfNull: false) int? maxTokens, @JsonKey(name: 'max_completion_tokens', includeIfNull: false) int? maxCompletionTokens, @JsonKey(includeIfNull: false) int? n, @JsonKey(includeIfNull: false) List<ChatCompletionModality>? modalities, @JsonKey(includeIfNull: false) PredictionContent? prediction, @JsonKey(includeIfNull: false) ChatCompletionAudioOptions? audio, @JsonKey(name: 'presence_penalty', includeIfNull: false) double? presencePenalty, @JsonKey(name: 'web_search_options', includeIfNull: false) WebSearchOptions? webSearchOptions, @JsonKey(name: 'response_format', includeIfNull: false) ResponseFormat? responseFormat, @JsonKey(includeIfNull: false) int? seed, @JsonKey(name: 'service_tier', includeIfNull: false, unknownEnumValue: JsonKey.nullForUndefinedEnumValue) CreateChatCompletionRequestServiceTier? serviceTier, @_ChatCompletionStopConverter() @JsonKey(includeIfNull: false) ChatCompletionStop? stop, @JsonKey(includeIfNull: false) @Default(false) bool? stream, @JsonKey(name: 'stream_options', includeIfNull: false) ChatCompletionStreamOptions? streamOptions, @JsonKey(includeIfNull: false) double? temperature, @JsonKey(name: 'top_p', includeIfNull: false) double? topP, @JsonKey(includeIfNull: false) List<ChatCompletionTool>? tools, @_ChatCompletionToolChoiceOptionConverter() @JsonKey(name: 'tool_choice', includeIfNull: false) ChatCompletionToolChoiceOption? toolChoice, @JsonKey(name: 'parallel_tool_calls', includeIfNull: false) bool? parallelToolCalls, @JsonKey(includeIfNull: false) String? user, @_ChatCompletionFunctionCallConverter() @JsonKey(name: 'function_call', includeIfNull: false) ChatCompletionFunctionCall? functionCall, @JsonKey(includeIfNull: false) List<FunctionObject>? functions})

Factory constructor for CreateChatCompletionRequest

const

factory

CreateChatCompletionRequest.fromJson(Map<String, dynamic> json)

Object construction from a JSON representation

factory

Properties

audio → ChatCompletionAudioOptions?

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

no setter, inherited

copyWith → $CreateChatCompletionRequestCopyWith<CreateChatCompletionRequest>

Create a copy of CreateChatCompletionRequest with the given fields replaced by the non-null parameter values.

no setter, inherited

frequencyPenalty → double?

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

no setter, inherited

functionCall → ChatCompletionFunctionCall?

Deprecated in favor of tool_choice.

no setter, inherited

functions → List<FunctionObject>?

Deprecated in favor of tools.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

logitBias → Map<String, int>?

Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

no setter, inherited

logprobs → bool?

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.

no setter, inherited

maxCompletionTokens → int?

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

no setter, inherited

maxTokens → int?

The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.

no setter, inherited

messages → List<ChatCompletionMessage>

A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio.

no setter, inherited

metadata → Map<String, String>?

Developer-defined tags and values used for filtering completions in the dashboard.

no setter, inherited

modalities → List<ChatCompletionModality>?

A list of modalities that the model may use to generate the completion.

no setter, inherited

model → ChatCompletionModel

ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

no setter, inherited

n → int?

How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

no setter, inherited

parallelToolCalls → bool?

Whether to enable parallel function calling during tool use.

no setter, inherited

prediction → PredictionContent?

Configuration for a Predicted Output, which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content.

no setter, inherited

presencePenalty → double?

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

no setter, inherited

reasoningEffort → ReasoningEffort?

o1 models only

no setter, inherited

responseFormat → ResponseFormat?

An object specifying the format that the model must output.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

seed → int?

This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

no setter, inherited

serviceTier → CreateChatCompletionRequestServiceTier?

Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the Flex Processing service:

no setter, inherited

stop → ChatCompletionStop?

Up to 4 sequences where the API will stop generating further tokens.

no setter, inherited

store → bool?

Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

no setter, inherited

stream → bool?

If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Example Python code.

no setter, inherited

streamOptions → ChatCompletionStreamOptions?

Options for streaming response. Only set this when you set stream: true.

no setter, inherited

temperature → double?

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

no setter, inherited

toolChoice → ChatCompletionToolChoiceOption?

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

no setter, inherited

tools → List<ChatCompletionTool>?

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.

no setter, inherited

topLogprobs → int?

An integer between 0 and 20 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.

no setter, inherited

topP → double?

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

no setter, inherited

user → String?

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

no setter, inherited

webSearchOptions → WebSearchOptions?

This tool searches the web for relevant results to use in a response.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this CreateChatCompletionRequest to a JSON map.

inherited

toMap() → Map<String, dynamic>

Map representation of object (not serialized)

toString() → String

A string representation of this object.

inherited

validateSchema() → String?

Perform validations on the schema property values

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

frequencyPenaltyMaxValue → const double

frequencyPenaltyMinValue → const double

Validation constants

nMaxValue → const int

nMinValue → const int

presencePenaltyMaxValue → const double

presencePenaltyMinValue → const double

propertyNames → const List<String>

List of all property names of schema

temperatureMaxValue → const double

temperatureMinValue → const double

topLogprobsMaxValue → const int

topLogprobsMinValue → const int

topPMaxValue → const double

topPMinValue → const double