Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ToolInputAvailableEvent.md

89 lines1.4 KB

Interface: ToolInputAvailableEvent

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

Emitted when a client tool is invoked. The agent loop yields this and pauses to let the caller run the tool client-side — structured-output.complete will not fire for that run. Shape fixed by the agent-loop forwarding in runStreamingStructuredOutputImpl in activities/chat/index.ts.

Extends

Indexable

[k: string]: unknown

Properties

model?

optional model: string;

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

Model identifier for multi-model support

Inherited from

CustomEvent.model


name

name: "tool-input-available";

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

Overrides

CustomEvent.name

value

value: object;

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

input

input: unknown;

toolCallId

toolCallId: string;

toolName

toolName: string;

Overrides

CustomEvent.value