You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/classes/StreamProcessor.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: StreamProcessor
5
5
6
6
# Class: StreamProcessor
7
7
8
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:148](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L148)
8
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:149](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L149)
9
9
10
10
StreamProcessor - State machine for processing AI response streams
11
11
@@ -32,7 +32,7 @@ State tracking:
32
32
newStreamProcessor(options): StreamProcessor;
33
33
```
34
34
35
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:185](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L185)
35
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:186](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L186)
36
36
37
37
#### Parameters
38
38
@@ -52,7 +52,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:185](https://gi
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:343](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L343)
55
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:344](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L344)
56
56
57
57
Add an approval response (called by client after handling onApprovalRequest)
58
58
@@ -81,7 +81,7 @@ addToolResult(
81
81
error?):void;
82
82
```
83
83
84
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:299](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L299)
84
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:300](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L300)
85
85
86
86
Add a tool result (called by client after handling onToolCall)
87
87
@@ -111,7 +111,7 @@ Add a tool result (called by client after handling onToolCall)
111
111
addUserMessage(content, id?):UIMessage;
112
112
```
113
113
114
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:232](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L232)
114
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:233](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L233)
115
115
116
116
Add a user message to the conversation.
117
117
Supports both simple string content and multimodal content arrays.
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:374](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L374)
163
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:375](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L375)
164
164
165
165
Check if all tool calls in the last assistant message are complete
166
166
Useful for auto-continue logic
@@ -177,7 +177,7 @@ Useful for auto-continue logic
177
177
clearMessages(): void;
178
178
```
179
179
180
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:443](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L443)
180
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:444](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L444)
181
181
182
182
Clear all messages
183
183
@@ -193,7 +193,7 @@ Clear all messages
193
193
finalizeStream(): void;
194
194
```
195
195
196
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1772](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1772)
196
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1812](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1812)
197
197
198
198
Finalize the stream — complete all pending operations.
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:283](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L283)
220
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:284](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L284)
221
221
222
222
Get the current assistant message ID (if one has been created).
223
223
Returns null if prepareAssistantMessage() was called but no content
@@ -235,7 +235,7 @@ has arrived yet.
235
235
getMessages(): UIMessage<unknown>[];
236
236
```
237
237
238
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:366](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L366)
238
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:367](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L367)
239
239
240
240
Get current messages
241
241
@@ -251,7 +251,7 @@ Get current messages
251
251
getRecording(): ChunkRecording|null;
252
252
```
253
253
254
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1936](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1936)
254
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1976](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1976)
255
255
256
256
Get the current recording
257
257
@@ -267,7 +267,7 @@ Get the current recording
267
267
getState(): ProcessorState;
268
268
```
269
269
270
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1893](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1893)
270
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1933](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1933)
271
271
272
272
Get current processor state (aggregated across all messages)
273
273
@@ -283,7 +283,7 @@ Get current processor state (aggregated across all messages)
283
283
prepareAssistantMessage(): void;
284
284
```
285
285
286
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:262](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L262)
286
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:263](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L263)
287
287
288
288
Prepare for a new assistant message stream.
289
289
Does NOT create the message immediately -- the message is created lazily
@@ -303,7 +303,7 @@ auto-continuation produces no content.
303
303
process(stream): Promise<ProcessorResult>;
304
304
```
305
305
306
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:461](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L461)
306
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:462](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L462)
307
307
308
308
Process a stream and emit events through handlers
309
309
@@ -325,7 +325,7 @@ Process a stream and emit events through handlers
325
325
processChunk(chunk): void;
326
326
```
327
327
328
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:495](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L495)
328
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:496](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L496)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:411](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L411)
358
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:412](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L412)
359
359
360
360
Remove messages after a certain index (for reload/retry)
361
361
@@ -377,7 +377,7 @@ Remove messages after a certain index (for reload/retry)
377
377
reset(): void;
378
378
```
379
379
380
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1961](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1961)
380
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2001](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2001)
381
381
382
382
Full reset (including messages)
383
383
@@ -393,7 +393,7 @@ Full reset (including messages)
393
393
setMessages(messages): void;
394
394
```
395
395
396
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:204](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L204)
396
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:205](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L205)
397
397
398
398
Set the messages array (e.g., from persisted state)
399
399
@@ -415,7 +415,7 @@ Set the messages array (e.g., from persisted state)
415
415
startAssistantMessage(messageId?):string;
416
416
```
417
417
418
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:271](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L271)
418
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:272](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L272)
419
419
420
420
#### Parameters
421
421
@@ -440,7 +440,7 @@ an assistant message which can cause empty message flicker.
440
440
startRecording(): void;
441
441
```
442
442
443
-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1923](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1923)
443
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1963](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1963)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:355](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L355)
462
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:356](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L356)
463
463
464
464
Get the conversation as ModelMessages (for sending to LLM)
465
465
@@ -478,7 +478,7 @@ Get the conversation as ModelMessages (for sending to LLM)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1980](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1980)
481
+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2020](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2020)
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L83)
8
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:123](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L123)
9
9
10
10
Manages tool call accumulation and execution for the chat() method's automatic tool execution loop.
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:87](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L87)
62
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L134)
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L113)
82
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:164](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L164)
73
83
74
84
Add a TOOL_CALL_ARGS event to accumulate arguments (AG-UI)
75
85
@@ -91,7 +101,7 @@ Add a TOOL_CALL_ARGS event to accumulate arguments (AG-UI)
91
101
addToolCallStartEvent(event): void;
92
102
```
93
103
94
-
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:94](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L94)
104
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:145](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L145)
95
105
96
106
Add a TOOL_CALL_START event to begin tracking a tool call (AG-UI)
97
107
@@ -113,7 +123,7 @@ Add a TOOL_CALL_START event to begin tracking a tool call (AG-UI)
113
123
clear(): void;
114
124
```
115
125
116
-
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:262](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L262)
126
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:324](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L324)
117
127
118
128
Clear the tool calls map for the next iteration
119
129
@@ -129,7 +139,7 @@ Clear the tool calls map for the next iteration
129
139
completeToolCall(event): void;
130
140
```
131
141
132
-
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:127](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L127)
142
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:178](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L178)
133
143
134
144
Complete a tool call with its final input
135
145
Called when TOOL_CALL_END is received
@@ -149,13 +159,13 @@ Called when TOOL_CALL_END is received
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:162](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L162)
168
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:213](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L213)
159
169
160
170
Execute all tool calls and return tool result messages
161
171
Yields TOOL_CALL_END events for streaming
@@ -168,6 +178,10 @@ Yields TOOL_CALL_END events for streaming
@@ -183,7 +197,7 @@ RUN_FINISHED event from the stream
183
197
getToolCalls(): ToolCall<unknown>[];
184
198
```
185
199
186
-
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:151](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L151)
200
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:202](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L202)
187
201
188
202
Get all complete tool calls (filtered for valid ID and name)
189
203
@@ -199,7 +213,7 @@ Get all complete tool calls (filtered for valid ID and name)
199
213
hasToolCalls(): boolean;
200
214
```
201
215
202
-
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:144](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L144)
216
+
Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:195](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L195)
203
217
204
218
Check if there are any complete tool calls to execute
Copy file name to clipboardExpand all lines: docs/reference/functions/chat.md
+23-3Lines changed: 23 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,10 @@ title: chat
6
6
# Function: chat()
7
7
8
8
```ts
9
-
function chat<TAdapter, TSchema, TStream>(options):TextActivityResult<TSchema, TStream>;
9
+
function chat<TAdapter, TSchema, TStream, TTools, TMiddleware>(options):TextActivityResult<TSchema, TStream>;
10
10
```
11
11
12
-
Defined in: [packages/ai/src/activities/chat/index.ts:2386](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L2386)
12
+
Defined in: [packages/ai/src/activities/chat/index.ts:2518](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L2518)
13
13
14
14
Text activity - handles agentic text generation, one-shot text generation, and agentic structured output.
15
15
@@ -33,11 +33,31 @@ This activity supports four modes:
Copy file name to clipboardExpand all lines: docs/reference/functions/chatParamsFromRequest.md
+1-4Lines changed: 1 addition & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ function chatParamsFromRequest(req): Promise<{
24
24
}>;
25
25
```
26
26
27
-
Defined in: [packages/ai/src/utilities/chat-params.ts:121](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L121)
27
+
Defined in: [packages/ai/src/utilities/chat-params.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L134)
28
28
29
29
Read an HTTP `Request`, parse its JSON body, and validate it as an
30
30
AG-UI `RunAgentInput` — collapsing the standard `req.json()` +
@@ -48,9 +48,6 @@ In frameworks that do not auto-handle thrown `Response` objects
48
48
with try/catch and return the caught Response yourself, or use
49
49
`chatParamsFromRequestBody` directly with your own JSON-parsing.
50
50
51
-
`context` is a deprecated alias of `aguiContext` kept for backward
0 commit comments