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

ToolCallPart.md

100 lines1.5 KB

1---
2id: ToolCallPart
3title: ToolCallPart
4---
5​
6# Interface: ToolCallPart
7​
8Defined in: [types.ts:245](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L245)
9​
10## Properties
11​
12### approval?
13​
14```ts
15optional approval: object;
16```
17​
18Defined in: [types.ts:252](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L252)
19​
20Approval metadata if tool requires user approval
21​
22#### approved?
23​
24```ts
25optional approved: boolean;
26```
27​
28#### id
29​
30```ts
31id: string;
32```
33​
34#### needsApproval
35​
36```ts
37needsApproval: boolean;
38```
39​
40***
41​
42### arguments
43​
44```ts
45arguments: string;
46```
47​
48Defined in: [types.ts:249](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L249)
49​
50***
51​
52### id
53​
54```ts
55id: string;
56```
57​
58Defined in: [types.ts:247](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L247)
59​
60***
61​
62### name
63​
64```ts
65name: string;
66```
67​
68Defined in: [types.ts:248](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L248)
69​
70***
71​
72### output?
73​
74```ts
75optional output: any;
76```
77​
78Defined in: [types.ts:258](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L258)
79​
80Tool execution output (for client tools or after approval)
81​
82***
83​
84### state
85​
86```ts
87state: ToolCallState;
88```
89​
90Defined in: [types.ts:250](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L250)
91​
92***
93​
94### type
95​
96```ts
97type: "tool-call";
98```
99​
100Defined in: [types.ts:246](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L246)