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

StreamProcessorHandlers.md

317 lines4.5 KB

1---
2id: StreamProcessorHandlers
3title: StreamProcessorHandlers
4---
5​
6# Interface: StreamProcessorHandlers
7​
8Defined in: [activities/chat/stream/processor.ts:85](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L85)
9​
10Legacy handlers for backward compatibility
11These are the old callback-style handlers
12​
13## Properties
14​
15### onApprovalRequested()?
16​
17```ts
18optional onApprovalRequested: (toolCallId, toolName, input, approvalId) => void;
19```
20​
21Defined in: [activities/chat/stream/processor.ts:116](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L116)
22​
23#### Parameters
24​
25##### toolCallId
26​
27`string`
28​
29##### toolName
30​
31`string`
32​
33##### input
34​
35`any`
36​
37##### approvalId
38​
39`string`
40​
41#### Returns
42​
43`void`
44​
45***
46​
47### onError()?
48​
49```ts
50optional onError: (error) => void;
51```
52​
53Defined in: [activities/chat/stream/processor.ts:130](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L130)
54​
55#### Parameters
56​
57##### error
58​
59###### code?
60​
61`string`
62​
63###### message
64​
65`string`
66​
67#### Returns
68​
69`void`
70​
71***
72​
73### onStreamEnd()?
74​
75```ts
76optional onStreamEnd: (content, toolCalls?) => void;
77```
78​
79Defined in: [activities/chat/stream/processor.ts:129](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L129)
80​
81#### Parameters
82​
83##### content
84​
85`string`
86​
87##### toolCalls?
88​
89[`ToolCall`](ToolCall.md)[]
90​
91#### Returns
92​
93`void`
94​
95***
96​
97### onTextUpdate()?
98​
99```ts
100optional onTextUpdate: (content) => void;
101```
102​
103Defined in: [activities/chat/stream/processor.ts:86](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L86)
104​
105#### Parameters
106​
107##### content
108​
109`string`
110​
111#### Returns
112​
113`void`
114​
115***
116​
117### onThinkingUpdate()?
118​
119```ts
120optional onThinkingUpdate: (content) => void;
121```
122​
123Defined in: [activities/chat/stream/processor.ts:87](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L87)
124​
125#### Parameters
126​
127##### content
128​
129`string`
130​
131#### Returns
132​
133`void`
134​
135***
136​
137### onToolCallComplete()?
138​
139```ts
140optional onToolCallComplete: (index, id, name, args) => void;
141```
142​
143Defined in: [activities/chat/stream/processor.ts:92](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L92)
144​
145#### Parameters
146​
147##### index
148​
149`number`
150​
151##### id
152​
153`string`
154​
155##### name
156​
157`string`
158​
159##### args
160​
161`string`
162​
163#### Returns
164​
165`void`
166​
167***
168​
169### onToolCallDelta()?
170​
171```ts
172optional onToolCallDelta: (index, args) => void;
173```
174​
175Defined in: [activities/chat/stream/processor.ts:91](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L91)
176​
177#### Parameters
178​
179##### index
180​
181`number`
182​
183##### args
184​
185`string`
186​
187#### Returns
188​
189`void`
190​
191***
192​
193### onToolCallStart()?
194​
195```ts
196optional onToolCallStart: (index, id, name) => void;
197```
198​
199Defined in: [activities/chat/stream/processor.ts:90](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L90)
200​
201#### Parameters
202​
203##### index
204​
205`number`
206​
207##### id
208​
209`string`
210​
211##### name
212​
213`string`
214​
215#### Returns
216​
217`void`
218​
219***
220​
221### onToolCallStateChange()?
222​
223```ts
224optional onToolCallStateChange: (index, id, name, state, args, parsedArgs?) => void;
225```
226​
227Defined in: [activities/chat/stream/processor.ts:98](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L98)
228​
229#### Parameters
230​
231##### index
232​
233`number`
234​
235##### id
236​
237`string`
238​
239##### name
240​
241`string`
242​
243##### state
244​
245[`ToolCallState`](../type-aliases/ToolCallState.md)
246​
247##### args
248​
249`string`
250​
251##### parsedArgs?
252​
253`any`
254​
255#### Returns
256​
257`void`
258​
259***
260​
261### onToolInputAvailable()?
262​
263```ts
264optional onToolInputAvailable: (toolCallId, toolName, input) => void;
265```
266​
267Defined in: [activities/chat/stream/processor.ts:122](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L122)
268​
269#### Parameters
270​
271##### toolCallId
272​
273`string`
274​
275##### toolName
276​
277`string`
278​
279##### input
280​
281`any`
282​
283#### Returns
284​
285`void`
286​
287***
288​
289### onToolResultStateChange()?
290​
291```ts
292optional onToolResultStateChange: (toolCallId, content, state, error?) => void;
293```
294​
295Defined in: [activities/chat/stream/processor.ts:108](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L108)
296​
297#### Parameters
298​
299##### toolCallId
300​
301`string`
302​
303##### content
304​
305`string`
306​
307##### state
308​
309[`ToolResultState`](../type-aliases/ToolResultState.md)
310​
311##### error?
312​
313`string`
314​
315#### Returns
316​
317`void`