AI SDK Kotlin/ai.torad.aisdk.ui/ToolCallState

ToolCallState

enum ToolCallState : Enum<ToolCallState> (source)

Tool call lifecycle in the UI. v6 names — input-streaming / input-available / output-available, NOT v5's partial-call / call / result.

State machine:

┌────────────────────┐
│ InputStreaming     │  model is still emitting tool input JSON tokens
└────────┬───────────┘
         │
         ▼
┌────────────────────┐
│ InputAvailable     │  full input is parsed, tool is executing
└────────┬───────────┘
         │
         ▼
┌────────────────────┐
│ OutputAvailable    │  tool returned, output is set
└────────────────────┘

(any state can transition to)  Error
(between states, optional)     ApprovalRequired

Entries

Properties

entries

val entries: EnumEntries<ToolCallState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): ToolCallState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ToolCallState>

Returns an array containing the constants of this enum type, in the order they're declared.