OpenAIRequestParameters class

Request-level parameters for the OpenAI Responses API.

Contains all model configuration and formatting options that apply to the request as a whole.

Constructors

OpenAIRequestParameters({required double? temperature, required double? topP, required int? maxOutputTokens, required bool? parallelToolCalls, required List<String>? include, required Map<String, dynamic>? metadata, required ReasoningOptions? reasoning, required Truncation? truncation, required TextFormat? textFormat, required String? user})
Creates a new request parameters object.
const

Properties

hashCode int
The hash code for this object.
no setterinherited
include List<String>?
Specific response fields to include.
final
maxOutputTokens int?
Maximum number of output tokens.
final
metadata Map<String, dynamic>?
Additional metadata forwarded to the API.
final
parallelToolCalls bool?
Whether the model may call multiple tools in parallel.
final
reasoning → ReasoningOptions?
Reasoning configuration for thinking models.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
temperature double?
Sampling temperature.
final
textFormat → TextFormat?
Text formatting/schema configuration.
final
topP double?
Nucleus sampling parameter.
final
truncation → Truncation?
Truncation configuration.
final
user String?
End-user identifier for abuse monitoring.
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