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

ToolInputAvailableEvent.md

89 lines1.5 KB

1---
2id: ToolInputAvailableEvent
3title: ToolInputAvailableEvent
4---
5​
6# Interface: ToolInputAvailableEvent
7​
8Defined in: [packages/typescript/ai/src/types.ts:1211](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1211)
9​
10Emitted when a client tool is invoked. The agent loop yields this and
11pauses to let the caller run the tool client-side — `structured-output.complete`
12will not fire for that run. Shape fixed by the agent-loop forwarding in
13`runStreamingStructuredOutputImpl` in `activities/chat/index.ts`.
14​
15## Extends
16​
17- [`CustomEvent`](CustomEvent.md)
18​
19## Indexable
20​
21```ts
22[k: string]: unknown
23```
24​
25## Properties
26​
27### model?
28​
29```ts
30optional model: string;
31```
32​
33Defined in: [packages/typescript/ai/src/types.ts:1147](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1147)
34​
35Model identifier for multi-model support
36​
37#### Inherited from
38​
39[`CustomEvent`](CustomEvent.md).[`model`](CustomEvent.md#model)
40​
41***
42​
43### name
44​
45```ts
46name: "tool-input-available";
47```
48​
49Defined in: [packages/typescript/ai/src/types.ts:1212](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1212)
50​
51#### Overrides
52​
53```ts
54CustomEvent.name
55```
56​
57***
58​
59### value
60​
61```ts
62value: object;
63```
64​
65Defined in: [packages/typescript/ai/src/types.ts:1213](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1213)
66​
67#### input
68​
69```ts
70input: unknown;
71```
72​
73#### toolCallId
74​
75```ts
76toolCallId: string;
77```
78​
79#### toolName
80​
81```ts
82toolName: string;
83```
84​
85#### Overrides
86​
87```ts
88CustomEvent.value
89```