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

ToolPhaseCompleteInfo.md

125 lines1.9 KB

1---
2id: ToolPhaseCompleteInfo
3title: ToolPhaseCompleteInfo
4---
5​
6# Interface: ToolPhaseCompleteInfo
7​
8Defined in: [packages/ai/src/activities/chat/middleware/types.ts:311](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L311)
9​
10Aggregate information passed to onToolPhaseComplete after all tool calls
11in an iteration have been processed.
12​
13## Properties
14​
15### needsApproval
16​
17```ts
18needsApproval: object[];
19```
20​
21Defined in: [packages/ai/src/activities/chat/middleware/types.ts:322](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L322)
22​
23Tools that need user approval
24​
25#### approvalId
26​
27```ts
28approvalId: string;
29```
30​
31#### input
32​
33```ts
34input: unknown;
35```
36​
37#### toolCallId
38​
39```ts
40toolCallId: string;
41```
42​
43#### toolName
44​
45```ts
46toolName: string;
47```
48​
49***
50​
51### needsClientExecution
52​
53```ts
54needsClientExecution: object[];
55```
56​
57Defined in: [packages/ai/src/activities/chat/middleware/types.ts:329](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L329)
58​
59Tools that need client-side execution
60​
61#### input
62​
63```ts
64input: unknown;
65```
66​
67#### toolCallId
68​
69```ts
70toolCallId: string;
71```
72​
73#### toolName
74​
75```ts
76toolName: string;
77```
78​
79***
80​
81### results
82​
83```ts
84results: object[];
85```
86​
87Defined in: [packages/ai/src/activities/chat/middleware/types.ts:315](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L315)
88​
89Completed tool results
90​
91#### duration?
92​
93```ts
94optional duration: number;
95```
96​
97#### result
98​
99```ts
100result: unknown;
101```
102​
103#### toolCallId
104​
105```ts
106toolCallId: string;
107```
108​
109#### toolName
110​
111```ts
112toolName: string;
113```
114​
115***
116​
117### toolCalls
118​
119```ts
120toolCalls: ToolCall<unknown>[];
121```
122​
123Defined in: [packages/ai/src/activities/chat/middleware/types.ts:313](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L313)
124​
125Tool calls that were assigned to the assistant message