OpenAIResponsesChatModelOptions class

Options for configuring the OpenAI Responses chat model.

Inheritance
Annotations
  • @immutable

Constructors

OpenAIResponsesChatModelOptions({double? temperature, double? topP, int? maxOutputTokens, bool? store, Map<String, dynamic>? metadata, List<String>? include, bool? parallelToolCalls, Map<String, dynamic>? reasoning, OpenAIReasoningEffort? reasoningEffort, OpenAIReasoningSummary? reasoningSummary, Map<String, dynamic>? responseFormat, Map<String, dynamic>? truncationStrategy, String? user, ImageDetail? imageDetail, Set<OpenAIServerSideTool>? serverSideTools, FileSearchConfig? fileSearchConfig, WebSearchConfig? webSearchConfig, CodeInterpreterConfig? codeInterpreterConfig, ImageGenerationConfig? imageGenerationConfig})
Creates a new set of options for the OpenAI Responses chat model.
const

Properties

codeInterpreterConfig → CodeInterpreterConfig?
Additional configuration for the code_interpreter server-side tool.
final
fileSearchConfig → FileSearchConfig?
Additional configuration for the file_search server-side tool.
final
hashCode → int
The hash code for this object.
no setterinherited
imageDetail → ImageDetail?
Preferred detail level when encoding image inputs.
final
imageGenerationConfig → ImageGenerationConfig?
Additional configuration for the image_generation server-side tool.
final
include → List<String>?
Specific response fields to include from the Responses API.
final
maxOutputTokens → int?
Maximum number of output tokens allowed for the response.
final
metadata → Map<String, dynamic>?
Additional metadata forwarded to the Responses API.
final
parallelToolCalls → bool?
Whether the model may call multiple tools in parallel.
final
reasoning → Map<String, dynamic>?
Reasoning configuration block for the Responses API.
final
reasoningEffort → OpenAIReasoningEffort?
Preferred reasoning effort for models that expose thinking controls.
final
reasoningSummary → OpenAIReasoningSummary?
Preferred reasoning summary verbosity (where supported).
final
responseFormat → Map<String, dynamic>?
Response formatting hints for the Responses API.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverSideTools → Set<OpenAIServerSideTool>?
Server-side Responses tools that should be enabled for this call.
final
store → bool?
Whether Responses session state should be persisted by the server.
final
temperature → double?
Sampling temperature passed to the Responses API.
final
topP → double?
Nucleus sampling parameter (top_p) passed to the Responses API.
final
truncationStrategy → Map<String, dynamic>?
Truncation configuration dictionary for the Responses API.
final
user → String?
End-user identifier for abuse monitoring.
final
webSearchConfig → WebSearchConfig?
Additional configuration for the web_search server-side tool.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited