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

ToolCallPart.md

138 lines2.6 KB

1---
2id: ToolCallPart
3title: ToolCallPart
4---
5​
6# Interface: ToolCallPart\<TMetadata\>
7​
8Defined in: [packages/ai/src/types.ts:370](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L370)
9​
10## Type Parameters
11​
12### TMetadata
13​
14`TMetadata` = `unknown`
15​
16## Properties
17​
18### approval?
19​
20```ts
21optional approval: object;
22```
23​
24Defined in: [packages/ai/src/types.ts:386](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L386)
25​
26Approval metadata if tool requires user approval
27​
28#### approved?
29​
30```ts
31optional approved: boolean;
32```
33​
34#### id
35​
36```ts
37id: string;
38```
39​
40#### needsApproval
41​
42```ts
43needsApproval: boolean;
44```
45​
46***
47​
48### arguments
49​
50```ts
51arguments: string;
52```
53​
54Defined in: [packages/ai/src/types.ts:374](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L374)
55​
56***
57​
58### id
59​
60```ts
61id: string;
62```
63​
64Defined in: [packages/ai/src/types.ts:372](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L372)
65​
66***
67​
68### input?
69​
70```ts
71optional input: unknown;
72```
73​
74Defined in: [packages/ai/src/types.ts:383](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L383)
75​
76Parsed tool input. Set from the parsed arguments once they are complete
77(`state: 'input-complete'` and later). `undefined` while the raw
78`arguments` string is still streaming, and may stay `undefined` for a call
79that terminates in an error state — the raw `arguments` string is always
80available as a fallback. Typed per-tool on the client `ToolCallPart` (see
81`@tanstack/ai-client`); `unknown` on this base type.
82​
83***
84​
85### metadata?
86​
87```ts
88optional metadata: TMetadata;
89```
90​
91Defined in: [packages/ai/src/types.ts:397](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L397)
92​
93Provider-specific metadata that round-trips with the tool call.
94Typed per-adapter via `TToolCallMetadata`. May follow the
95[ProviderExecutedToolMetadata](ProviderExecutedToolMetadata.md) convention to mark provider-executed
96server tools (e.g. Anthropic `web_search`).
97​
98***
99​
100### name
101​
102```ts
103name: string;
104```
105​
106Defined in: [packages/ai/src/types.ts:373](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L373)
107​
108***
109​
110### output?
111​
112```ts
113optional output: any;
114```
115​
116Defined in: [packages/ai/src/types.ts:392](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L392)
117​
118Tool execution output (for client tools or after approval)
119​
120***
121​
122### state
123​
124```ts
125state: ToolCallState;
126```
127​
128Defined in: [packages/ai/src/types.ts:384](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L384)
129​
130***
131​
132### type
133​
134```ts
135type: "tool-call";
136```
137​
138Defined in: [packages/ai/src/types.ts:371](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L371)