RunSubmitToolOutput class abstract

Output of a tool.

Available extensions
Annotations
  • @freezed

Constructors

RunSubmitToolOutput({@JsonKey.new(name: 'tool_call_id', includeIfNull: false) String? toolCallId, @JsonKey.new(includeIfNull: false) String? output})
Factory constructor for RunSubmitToolOutput
const
factory
RunSubmitToolOutput.fromJson(Map<String, dynamic> json)
Object construction from a JSON representation
factory

Properties

copyWith → $RunSubmitToolOutputCopyWith<RunSubmitToolOutput>
Create a copy of RunSubmitToolOutput with the given fields replaced by the non-null parameter values.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
output String?
The output of the tool call to be submitted to continue the run.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
toolCallId String?
The ID of the tool call in the required_action object within the run object the output is being submitted for.
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_RunSubmitToolOutput value)) → TResult

Available on RunSubmitToolOutput, provided by the RunSubmitToolOutputPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_RunSubmitToolOutput value)?) → TResult?

Available on RunSubmitToolOutput, provided by the RunSubmitToolOutputPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_RunSubmitToolOutput value)?, {required TResult orElse()}) → TResult

Available on RunSubmitToolOutput, provided by the RunSubmitToolOutputPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(String? toolCallId, String? output)?, {required TResult orElse()}) → TResult

Available on RunSubmitToolOutput, provided by the RunSubmitToolOutputPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Serializes this RunSubmitToolOutput 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
when<TResult extends Object?>(TResult $default(String? toolCallId, String? output)) → TResult

Available on RunSubmitToolOutput, provided by the RunSubmitToolOutputPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String? toolCallId, String? output)?) → TResult?

Available on RunSubmitToolOutput, provided by the RunSubmitToolOutputPatterns extension

A variant of when that fallback to returning null

Operators

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

Constants

propertyNames → const List<String>
List of all property names of schema