ToolInputAvailableEvent

Defined in: packages/ai/src/types.ts:1603

Deprecated#

Native interrupts use RUN_FINISHED interrupt outcomes. This compatibility event remains readable until 1.0.

Extends#

• CustomEvent

Properties#

metadata?#

optional metadata?: Record<string, any>;

Defined in: packages/ai/src/types.ts:1531

Extra information attached to this event.

Inherited from#

CustomEvent.metadata

name#

name: "tool-input-available";

Defined in: packages/ai/src/types.ts:1604

What this custom event is. Required: without it a consumer cannot route the value.

Overrides#

CustomEvent.name

type#

type: "CUSTOM";

Defined in: packages/ai/src/types.ts:1530

Inherited from#

CustomEvent.type

value#

value: object;

Defined in: packages/ai/src/types.ts:1605

The payload. Any JSON value, and required.

input#

input: unknown;

toolCallId#

toolCallId: string;

toolName#

toolName: string;

Overrides#

CustomEvent.value