ToolInterruptResult<Output> class final

An interrupt result that bubbles the tool request back to the caller with an optional data payload.

Inheritance

Constructors

ToolInterruptResult([Object? data])
const

Properties

data → Object?
The interrupt data payload.
final
hashCode → int
The hash code for this object.
no setterinherited
hasInterrupt → bool
Whether this is a ToolInterruptResult that halted the generation loop.
no setterinherited
hasResponse → bool
Whether this is a normal ToolResponseResult carrying structured output.
no setterinherited
interruptData → Object?
The interrupt data payload of an interrupt result.
no setterinherited
output → Output
The structured output of a normal tool response.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this result to the multipart tool.v2 shape ({output, content?, metadata?} or {interrupt}). Used at the reflection boundary so the Dev UI can render tool results.
override
toString() → String
A string representation of this object.
inherited

Operators

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