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

ChatMiddlewareContext.md

492 lines10.6 KB

1---
2id: ChatMiddlewareContext
3title: ChatMiddlewareContext
4---
5​
6# Interface: ChatMiddlewareContext\<TContext\>
7​
8Defined in: [packages/ai/src/activities/chat/middleware/types.ts:86](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L86)
9​
10Stable context object passed to all middleware hooks.
11Created once per chat() invocation and shared across all hooks.
12​
13## Type Parameters
14​
15### TContext
16​
17`TContext` = `unknown`
18​
19## Properties
20​
21### abort()
22​
23```ts
24abort: (reason?) => void;
25```
26​
27Defined in: [packages/ai/src/activities/chat/middleware/types.ts:115](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L115)
28​
29Abort the chat run with a reason
30​
31#### Parameters
32​
33##### reason?
34​
35`string`
36​
37#### Returns
38​
39`void`
40​
41***
42​
43### accumulatedContent
44​
45```ts
46accumulatedContent: string;
47```
48​
49Defined in: [packages/ai/src/activities/chat/middleware/types.ts:166](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L166)
50​
51Accumulated text content for the current iteration
52​
53***
54​
55### activity
56​
57```ts
58activity: "chat";
59```
60​
61Defined in: [packages/ai/src/activities/chat/middleware/types.ts:133](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L133)
62​
63Which activity this context describes — always `'chat'`. Present so the
64chat context structurally satisfies the base `GenerationMiddlewareContext`,
65letting an observe-only middleware authored against the base (e.g.
66`otelMiddleware`) run on both chat and media activities.
67​
68***
69​
70### capabilities
71​
72```ts
73capabilities: CapabilityRegistry;
74```
75​
76Defined in: [packages/ai/src/activities/chat/middleware/types.ts:180](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L180)
77​
78Capability bookkeeping for this request. Populated by middleware `setup`
79hooks (via `provide` accessors) and read by later middleware (via `get`
80accessors). Prefer the accessors returned by `createCapability` over using
81this directly. Orthogonal to `context` (the user runtime context).
82​
83***
84​
85### chunkIndex
86​
87```ts
88chunkIndex: number;
89```
90​
91Defined in: [packages/ai/src/activities/chat/middleware/types.ts:111](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L111)
92​
93Running count of chunks yielded so far
94​
95***
96​
97### context
98​
99```ts
100context: TContext;
101```
102​
103Defined in: [packages/ai/src/activities/chat/middleware/types.ts:117](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L117)
104​
105Runtime context provided by chat() options
106​
107***
108​
109### ~~conversationId?~~
110​
111```ts
112optional conversationId: string;
113```
114​
115Defined in: [packages/ai/src/activities/chat/middleware/types.ts:105](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L105)
116​
117#### Deprecated
118​
119Use `threadId` instead. Retained as an alias of
120`threadId` so middleware written before the AG-UI rename keeps
121working unchanged. Will be removed in a future major release.
122​
123***
124​
125### createId()
126​
127```ts
128createId: (prefix) => string;
129```
130​
131Defined in: [packages/ai/src/activities/chat/middleware/types.ts:173](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L173)
132​
133Generate a unique ID with the given prefix
134​
135#### Parameters
136​
137##### prefix
138​
139`string`
140​
141#### Returns
142​
143`string`
144​
145***
146​
147### currentMessageId
148​
149```ts
150currentMessageId: string | null;
151```
152​
153Defined in: [packages/ai/src/activities/chat/middleware/types.ts:164](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L164)
154​
155Current assistant message ID (changes per iteration)
156​
157***
158​
159### defer()
160​
161```ts
162defer: (promise) => void;
163```
164​
165Defined in: [packages/ai/src/activities/chat/middleware/types.ts:123](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L123)
166​
167Defer a non-blocking side-effect promise.
168Deferred promises do not block streaming and are awaited
169after the terminal hook (onFinish/onAbort/onError).
170​
171#### Parameters
172​
173##### promise
174​
175`Promise`\<`unknown`\>
176​
177#### Returns
178​
179`void`
180​
181***
182​
183### get()
184​
185```ts
186get: <TValue>(capability) => TValue;
187```
188​
189Defined in: [packages/ai/src/activities/chat/middleware/types.ts:185](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L185)
190​
191Read a provided capability by its handle. Equivalent to the handle's own
192`get` accessor (`getX(ctx)`); throws if the capability was never provided.
193​
194#### Type Parameters
195​
196##### TValue
197​
198`TValue`
199​
200#### Parameters
201​
202##### capability
203​
204[`Capability`](../type-aliases/Capability.md)\<`TValue`\>
205​
206#### Returns
207​
208`TValue`
209​
210***
211​
212### getOptional()
213​
214```ts
215getOptional: <TValue>(capability) => TValue | undefined;
216```
217​
218Defined in: [packages/ai/src/activities/chat/middleware/types.ts:190](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L190)
219​
220Read a capability by its handle, returning `undefined` if it was never
221provided (never throws).
222​
223#### Type Parameters
224​
225##### TValue
226​
227`TValue`
228​
229#### Parameters
230​
231##### capability
232​
233[`Capability`](../type-aliases/Capability.md)\<`TValue`\>
234​
235#### Returns
236​
237`TValue` \| `undefined`
238​
239***
240​
241### hasTools
242​
243```ts
244hasTools: boolean;
245```
246​
247Defined in: [packages/ai/src/activities/chat/middleware/types.ts:159](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L159)
248​
249Whether tools are configured
250​
251***
252​
253### iteration
254​
255```ts
256iteration: number;
257```
258​
259Defined in: [packages/ai/src/activities/chat/middleware/types.ts:109](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L109)
260​
261Current agent loop iteration (0-indexed)
262​
263***
264​
265### messageCount
266​
267```ts
268messageCount: number;
269```
270​
271Defined in: [packages/ai/src/activities/chat/middleware/types.ts:157](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L157)
272​
273Number of messages at the start of the request
274​
275***
276​
277### messages
278​
279```ts
280messages: readonly ModelMessage<
281 | string
282 | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
283 | null>[];
284```
285​
286Defined in: [packages/ai/src/activities/chat/middleware/types.ts:171](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L171)
287​
288Current messages array (read-only view)
289​
290***
291​
292### model
293​
294```ts
295model: string;
296```
297​
298Defined in: [packages/ai/src/activities/chat/middleware/types.ts:137](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L137)
299​
300Model identifier (e.g., 'gpt-4o')
301​
302***
303​
304### modelOptions?
305​
306```ts
307optional modelOptions: Record<string, unknown>;
308```
309​
310Defined in: [packages/ai/src/activities/chat/middleware/types.ts:152](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L152)
311​
312Provider-specific model options
313​
314***
315​
316### options?
317​
318```ts
319optional options: Record<string, unknown>;
320```
321​
322Defined in: [packages/ai/src/activities/chat/middleware/types.ts:150](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L150)
323​
324Flattened generation options (metadata)
325​
326***
327​
328### phase
329​
330```ts
331phase: ChatMiddlewarePhase;
332```
333​
334Defined in: [packages/ai/src/activities/chat/middleware/types.ts:107](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L107)
335​
336Current lifecycle phase
337​
338***
339​
340### provide()
341​
342```ts
343provide: <TValue>(capability, value) => void;
344```
345​
346Defined in: [packages/ai/src/activities/chat/middleware/types.ts:195](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L195)
347​
348Provide a capability value. Equivalent to the handle's own `provide`
349accessor (`provideX(ctx, value)`). Typically called from `setup`.
350​
351#### Type Parameters
352​
353##### TValue
354​
355`TValue`
356​
357#### Parameters
358​
359##### capability
360​
361[`Capability`](../type-aliases/Capability.md)\<`TValue`\>
362​
363##### value
364​
365`TValue`
366​
367#### Returns
368​
369`void`
370​
371***
372​
373### provider
374​
375```ts
376provider: string;
377```
378​
379Defined in: [packages/ai/src/activities/chat/middleware/types.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L135)
380​
381Provider name (e.g., 'openai', 'anthropic')
382​
383***
384​
385### requestId
386​
387```ts
388requestId: string;
389```
390​
391Defined in: [packages/ai/src/activities/chat/middleware/types.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L88)
392​
393Unique identifier for this chat request
394​
395***
396​
397### runId
398​
399```ts
400runId: string;
401```
402​
403Defined in: [packages/ai/src/activities/chat/middleware/types.ts:92](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L92)
404​
405AG-UI run identifier for correlating client and server events
406​
407***
408​
409### signal?
410​
411```ts
412optional signal: AbortSignal;
413```
414​
415Defined in: [packages/ai/src/activities/chat/middleware/types.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L113)
416​
417Abort signal from the chat request
418​
419***
420​
421### source
422​
423```ts
424source: "server" | "client";
425```
426​
427Defined in: [packages/ai/src/activities/chat/middleware/types.ts:139](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L139)
428​
429Source of the chat invocation — always 'server' for server-side chat
430​
431***
432​
433### streamId
434​
435```ts
436streamId: string;
437```
438​
439Defined in: [packages/ai/src/activities/chat/middleware/types.ts:90](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L90)
440​
441Unique identifier for this stream
442​
443***
444​
445### streaming
446​
447```ts
448streaming: boolean;
449```
450​
451Defined in: [packages/ai/src/activities/chat/middleware/types.ts:141](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L141)
452​
453Whether the chat is streaming
454​
455***
456​
457### systemPrompts
458​
459```ts
460systemPrompts: SystemPrompt[];
461```
462​
463Defined in: [packages/ai/src/activities/chat/middleware/types.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L146)
464​
465System prompts configured for this chat
466​
467***
468​
469### threadId
470​
471```ts
472threadId: string;
473```
474​
475Defined in: [packages/ai/src/activities/chat/middleware/types.ts:99](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L99)
476​
477AG-UI thread identifier — a stable per-conversation ID used to
478correlate client and server devtools events. Resolves to the
479caller-provided `threadId` (or legacy `conversationId`), or an
480auto-generated value when neither is supplied.
481​
482***
483​
484### toolNames?
485​
486```ts
487optional toolNames: string[];
488```
489​
490Defined in: [packages/ai/src/activities/chat/middleware/types.ts:148](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L148)
491​
492Names of configured tools, if any