CreateRunRequest class

A request to create a run.

Annotations
  • @immutable

Constructors

CreateRunRequest({required String assistantId, String? model, String? instructions, String? additionalInstructions, List<Map<String, dynamic>>? additionalMessages, List<AssistantTool>? tools, Map<String, String>? metadata, double? temperature, double? topP, bool? stream, int? maxPromptTokens, int? maxCompletionTokens, TruncationStrategy? truncationStrategy, ToolChoice? toolChoice, bool? parallelToolCalls, ResponseFormat? responseFormat})
Creates a CreateRunRequest.
const
CreateRunRequest.fromJson(Map<String, dynamic> json)
Creates a CreateRunRequest from JSON.
factory

Properties

additionalInstructions → String?
Additional instructions appended to the assistant's instructions.
final
additionalMessages → List<Map<String, dynamic>>?
Additional messages to add before the run.
final
assistantId → String
The assistant ID.
final
hashCode → int
The hash code for this object.
no setteroverride
instructions → String?
Instructions to override the assistant's instructions.
final
maxCompletionTokens → int?
Maximum completion tokens.
final
maxPromptTokens → int?
Maximum prompt tokens.
final
metadata → Map<String, String>?
Custom metadata.
final
model → String?
The model to use (overrides assistant's model).
final
parallelToolCalls → bool?
Whether parallel tool calls are enabled.
final
responseFormat → ResponseFormat?
The response format.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stream → bool?
Whether to stream the response.
final
temperature → double?
The sampling temperature.
final
toolChoice → ToolChoice?
The tool choice setting.
final
tools → List<AssistantTool>?
Tools to override the assistant's tools.
final
topP → double?
The nucleus sampling parameter.
final
truncationStrategy → TruncationStrategy?
The truncation strategy.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts to JSON.
toString() → String
A string representation of this object.
override

Operators

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