Skip to content

Commit f008c5f

Browse files
docs: regenerate API documentation (#674)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 11ce2a1 commit f008c5f

134 files changed

Lines changed: 991 additions & 641 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/reference/classes/StreamProcessor.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: StreamProcessor
55

66
# Class: StreamProcessor
77

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)
99

1010
StreamProcessor - State machine for processing AI response streams
1111

@@ -32,7 +32,7 @@ State tracking:
3232
new StreamProcessor(options): StreamProcessor;
3333
```
3434

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)
3636

3737
#### Parameters
3838

@@ -52,7 +52,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:185](https://gi
5252
addToolApprovalResponse(approvalId, approved): void;
5353
```
5454

55-
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)
5656

5757
Add an approval response (called by client after handling onApprovalRequest)
5858

@@ -81,7 +81,7 @@ addToolResult(
8181
error?): void;
8282
```
8383
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)
8585
8686
Add a tool result (called by client after handling onToolCall)
8787
@@ -111,7 +111,7 @@ Add a tool result (called by client after handling onToolCall)
111111
addUserMessage(content, id?): UIMessage;
112112
```
113113
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)
115115
116116
Add a user message to the conversation.
117117
Supports both simple string content and multimodal content arrays.
@@ -160,7 +160,7 @@ processor.addUserMessage('Hello!', 'custom-id-123')
160160
areAllToolsComplete(): boolean;
161161
```
162162
163-
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)
164164
165165
Check if all tool calls in the last assistant message are complete
166166
Useful for auto-continue logic
@@ -177,7 +177,7 @@ Useful for auto-continue logic
177177
clearMessages(): void;
178178
```
179179
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)
181181
182182
Clear all messages
183183
@@ -193,7 +193,7 @@ Clear all messages
193193
finalizeStream(): void;
194194
```
195195
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)
197197
198198
Finalize the stream — complete all pending operations.
199199
@@ -217,7 +217,7 @@ docs/chat-architecture.md#single-shot-text-response — Finalization step
217217
getCurrentAssistantMessageId(): string | null;
218218
```
219219
220-
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)
221221
222222
Get the current assistant message ID (if one has been created).
223223
Returns null if prepareAssistantMessage() was called but no content
@@ -235,7 +235,7 @@ has arrived yet.
235235
getMessages(): UIMessage<unknown>[];
236236
```
237237
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)
239239
240240
Get current messages
241241
@@ -251,7 +251,7 @@ Get current messages
251251
getRecording(): ChunkRecording | null;
252252
```
253253
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)
255255
256256
Get the current recording
257257
@@ -267,7 +267,7 @@ Get the current recording
267267
getState(): ProcessorState;
268268
```
269269
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)
271271
272272
Get current processor state (aggregated across all messages)
273273
@@ -283,7 +283,7 @@ Get current processor state (aggregated across all messages)
283283
prepareAssistantMessage(): void;
284284
```
285285
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)
287287
288288
Prepare for a new assistant message stream.
289289
Does NOT create the message immediately -- the message is created lazily
@@ -303,7 +303,7 @@ auto-continuation produces no content.
303303
process(stream): Promise<ProcessorResult>;
304304
```
305305
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)
307307
308308
Process a stream and emit events through handlers
309309
@@ -325,7 +325,7 @@ Process a stream and emit events through handlers
325325
processChunk(chunk): void;
326326
```
327327
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)
329329
330330
Process a single chunk from the stream.
331331
@@ -355,7 +355,7 @@ docs/chat-architecture.md#adapter-contract — Expected event types and ordering
355355
removeMessagesAfter(index): void;
356356
```
357357
358-
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)
359359
360360
Remove messages after a certain index (for reload/retry)
361361
@@ -377,7 +377,7 @@ Remove messages after a certain index (for reload/retry)
377377
reset(): void;
378378
```
379379
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)
381381
382382
Full reset (including messages)
383383
@@ -393,7 +393,7 @@ Full reset (including messages)
393393
setMessages(messages): void;
394394
```
395395
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)
397397
398398
Set the messages array (e.g., from persisted state)
399399
@@ -415,7 +415,7 @@ Set the messages array (e.g., from persisted state)
415415
startAssistantMessage(messageId?): string;
416416
```
417417
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)
419419
420420
#### Parameters
421421
@@ -440,7 +440,7 @@ an assistant message which can cause empty message flicker.
440440
startRecording(): void;
441441
```
442442
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)
444444
445445
Start recording chunks
446446
@@ -459,7 +459,7 @@ toModelMessages(): ModelMessage<
459459
| null>[];
460460
```
461461
462-
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)
463463
464464
Get the conversation as ModelMessages (for sending to LLM)
465465
@@ -478,7 +478,7 @@ Get the conversation as ModelMessages (for sending to LLM)
478478
static replay(recording, options?): Promise<ProcessorResult>;
479479
```
480480
481-
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)
482482
483483
Replay a recording through the processor
484484

docs/reference/classes/ToolCallManager.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ id: ToolCallManager
33
title: ToolCallManager
44
---
55

6-
# Class: ToolCallManager
6+
# Class: ToolCallManager\<TToolsOrContext, TContext\>
77

8-
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)
99

1010
Manages tool call accumulation and execution for the chat() method's automatic tool execution loop.
1111

@@ -41,25 +41,35 @@ if (manager.hasToolCalls()) {
4141
}
4242
```
4343

44+
## Type Parameters
45+
46+
### TToolsOrContext
47+
48+
`TToolsOrContext` = `ReadonlyArray`\<[`AnyTool`](../type-aliases/AnyTool.md)\>
49+
50+
### TContext
51+
52+
`TContext` = `TToolsOrContext` *extends* `ReadonlyArray`\<[`AnyTool`](../type-aliases/AnyTool.md)\> ? `ContextFromTools`\<`TToolsOrContext`\> : `TToolsOrContext`
53+
4454
## Constructors
4555

4656
### Constructor
4757

4858
```ts
49-
new ToolCallManager(tools): ToolCallManager;
59+
new ToolCallManager<TToolsOrContext, TContext>(tools): ToolCallManager<TToolsOrContext, TContext>;
5060
```
5161

52-
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)
5363

5464
#### Parameters
5565

5666
##### tools
5767

58-
readonly [`Tool`](../interfaces/Tool.md)\<[`SchemaInput`](../type-aliases/SchemaInput.md), [`SchemaInput`](../type-aliases/SchemaInput.md), `string`\>[]
68+
`TToolsOrContext` *extends* readonly [`AnyTool`](../type-aliases/AnyTool.md)[] ? `TToolsOrContext`\<`TToolsOrContext`\> : readonly [`AnyTool`](../type-aliases/AnyTool.md)[]
5969

6070
#### Returns
6171

62-
`ToolCallManager`
72+
`ToolCallManager`\<`TToolsOrContext`, `TContext`\>
6373

6474
## Methods
6575

@@ -69,7 +79,7 @@ readonly [`Tool`](../interfaces/Tool.md)\<[`SchemaInput`](../type-aliases/Schema
6979
addToolCallArgsEvent(event): void;
7080
```
7181

72-
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)
7383

7484
Add a TOOL_CALL_ARGS event to accumulate arguments (AG-UI)
7585

@@ -91,7 +101,7 @@ Add a TOOL_CALL_ARGS event to accumulate arguments (AG-UI)
91101
addToolCallStartEvent(event): void;
92102
```
93103

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)
95105

96106
Add a TOOL_CALL_START event to begin tracking a tool call (AG-UI)
97107

@@ -113,7 +123,7 @@ Add a TOOL_CALL_START event to begin tracking a tool call (AG-UI)
113123
clear(): void;
114124
```
115125

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)
117127

118128
Clear the tool calls map for the next iteration
119129

@@ -129,7 +139,7 @@ Clear the tool calls map for the next iteration
129139
completeToolCall(event): void;
130140
```
131141

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)
133143

134144
Complete a tool call with its final input
135145
Called when TOOL_CALL_END is received
@@ -149,13 +159,13 @@ Called when TOOL_CALL_END is received
149159
### executeTools()
150160

151161
```ts
152-
executeTools(finishEvent): AsyncGenerator<ToolCallEndEvent, ModelMessage<
162+
executeTools(finishEvent, ...contextArgs): AsyncGenerator<ToolCallEndEvent, ModelMessage<
153163
| string
154164
| ContentPart<unknown, unknown, unknown, unknown, unknown>[]
155165
| null>[], void>;
156166
```
157167

158-
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)
159169

160170
Execute all tool calls and return tool result messages
161171
Yields TOOL_CALL_END events for streaming
@@ -168,6 +178,10 @@ Yields TOOL_CALL_END events for streaming
168178

169179
RUN_FINISHED event from the stream
170180

181+
##### contextArgs
182+
183+
...`ExecuteToolsContextArgs`\<`TContext`\>
184+
171185
#### Returns
172186

173187
`AsyncGenerator`\<[`ToolCallEndEvent`](../interfaces/ToolCallEndEvent.md), [`ModelMessage`](../interfaces/ModelMessage.md)\<
@@ -183,7 +197,7 @@ RUN_FINISHED event from the stream
183197
getToolCalls(): ToolCall<unknown>[];
184198
```
185199

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)
187201

188202
Get all complete tool calls (filtered for valid ID and name)
189203

@@ -199,7 +213,7 @@ Get all complete tool calls (filtered for valid ID and name)
199213
hasToolCalls(): boolean;
200214
```
201215

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)
203217

204218
Check if there are any complete tool calls to execute
205219

docs/reference/functions/chat.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ title: chat
66
# Function: chat()
77

88
```ts
9-
function chat<TAdapter, TSchema, TStream>(options): TextActivityResult<TSchema, TStream>;
9+
function chat<TAdapter, TSchema, TStream, TTools, TMiddleware>(options): TextActivityResult<TSchema, TStream>;
1010
```
1111

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)
1313

1414
Text activity - handles agentic text generation, one-shot text generation, and agentic structured output.
1515

@@ -33,11 +33,31 @@ This activity supports four modes:
3333

3434
`TStream` *extends* `boolean` = `boolean`
3535

36+
### TTools
37+
38+
`TTools` *extends*
39+
\| (
40+
\| `Omit`\<[`Tool`](../interfaces/Tool.md)\<`any`, `any`, `any`, `any`\>, `"execute"`\> & `object` & `object`
41+
\| [`ProviderTool`](../interfaces/ProviderTool.md)\<`string`, `TAdapter`\[`"~types"`\]\[`"toolCapabilities"`\]\[`number`\]\>)[]
42+
\| `undefined` =
43+
\| (
44+
\| `Omit`\<[`Tool`](../interfaces/Tool.md)\<`any`, `any`, `any`, `any`\>, `"execute"`\> & `object` & `object`
45+
\| [`ProviderTool`](../interfaces/ProviderTool.md)\<`string`, `TAdapter`\[`"~types"`\]\[`"toolCapabilities"`\]\[`number`\]\>)[]
46+
\| `undefined`
47+
48+
### TMiddleware
49+
50+
`TMiddleware` *extends*
51+
\| [`ChatMiddleware`](../interfaces/ChatMiddleware.md)\<`any`\>[]
52+
\| `undefined` =
53+
\| [`ChatMiddleware`](../interfaces/ChatMiddleware.md)\<`any`\>[]
54+
\| `undefined`
55+
3656
## Parameters
3757

3858
### options
3959

40-
`TextActivityOptions`\<`TAdapter`, `TSchema`, `TStream`\>
60+
`TextActivityOptionsWithContext`\<`TAdapter`, `TSchema`, `TStream`, `TTools`, `TMiddleware`\>
4161

4262
## Returns
4363

docs/reference/functions/chatParamsFromRequest.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ function chatParamsFromRequest(req): Promise<{
2424
}>;
2525
```
2626

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)
2828

2929
Read an HTTP `Request`, parse its JSON body, and validate it as an
3030
AG-UI `RunAgentInput` — collapsing the standard `req.json()` +
@@ -48,9 +48,6 @@ In frameworks that do not auto-handle thrown `Response` objects
4848
with try/catch and return the caught Response yourself, or use
4949
`chatParamsFromRequestBody` directly with your own JSON-parsing.
5050

51-
`context` is a deprecated alias of `aguiContext` kept for backward
52-
compatibility.
53-
5451
## Parameters
5552

5653
### req

0 commit comments

Comments
 (0)