Open History to see the last commit
1---
2id: ChatMiddlewareContext
3title: ChatMiddlewareContext
4---
5
6# Interface: ChatMiddlewareContext
7
8Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:36](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L36)
9
10Stable context object passed to all middleware hooks.
11Created once per chat() invocation and shared across all hooks.
12
13## Properties
14
15### abort()
16
17```ts
18abort: (reason?) => void;
19```
20
21Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:63](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L63)
22
23Abort the chat run with a reason
24
25#### Parameters
26
27##### reason?
28
29`string`
30
31#### Returns
32
33`void`
34
35***
36
37### accumulatedContent
38
39```ts
40accumulatedContent: string;
41```
42
43Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:107](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L107)
44
45Accumulated text content for the current iteration
46
47***
48
49### chunkIndex
50
51```ts
52chunkIndex: number;
53```
54
55Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:59](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L59)
56
57Running count of chunks yielded so far
58
59***
60
61### context
62
63```ts
64context: unknown;
65```
66
67Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:65](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L65)
68
69Opaque user-provided value from chat() options
70
71***
72
73### ~~conversationId?~~
74
75```ts
76optional conversationId: string;
77```
78
79Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:53](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L53)
80
81#### Deprecated
82
83Use `threadId` instead. Retained as an alias of
84`threadId` so middleware written before the AG-UI rename keeps
85working unchanged. Will be removed in a future major release.
86
87***
88
89### createId()
90
91```ts
92createId: (prefix) => string;
93```
94
95Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:114](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L114)
96
97Generate a unique ID with the given prefix
98
99#### Parameters
100
101##### prefix
102
103`string`
104
105#### Returns
106
107`string`
108
109***
110
111### currentMessageId
112
113```ts
114currentMessageId: string | null;
115```
116
117Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:105](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L105)
118
119Current assistant message ID (changes per iteration)
120
121***
122
123### defer()
124
125```ts
126defer: (promise) => void;
127```
128
129Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:71](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L71)
130
131Defer a non-blocking side-effect promise.
132Deferred promises do not block streaming and are awaited
133after the terminal hook (onFinish/onAbort/onError).
134
135#### Parameters
136
137##### promise
138
139`Promise`\<`unknown`\>
140
141#### Returns
142
143`void`
144
145***
146
147### hasTools
148
149```ts
150hasTools: boolean;
151```
152
153Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:100](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L100)
154
155Whether tools are configured
156
157***
158
159### iteration
160
161```ts
162iteration: number;
163```
164
165Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:57](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L57)
166
167Current agent loop iteration (0-indexed)
168
169***
170
171### messageCount
172
173```ts
174messageCount: number;
175```
176
177Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:98](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L98)
178
179Number of messages at the start of the request
180
181***
182
183### messages
184
185```ts
186messages: readonly ModelMessage<
187 | string
188 | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
189 | null>[];
190```
191
192Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:112](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L112)
193
194Current messages array (read-only view)
195
196***
197
198### model
199
200```ts
201model: string;
202```
203
204Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:78](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L78)
205
206Model identifier (e.g., 'gpt-4o')
207
208***
209
210### modelOptions?
211
212```ts
213optional modelOptions: Record<string, unknown>;
214```
215
216Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:93](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L93)
217
218Provider-specific model options
219
220***
221
222### options?
223
224```ts
225optional options: Record<string, unknown>;
226```
227
228Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:91](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L91)
229
230Flattened generation options (temperature, topP, maxTokens, metadata)
231
232***
233
234### phase
235
236```ts
237phase: ChatMiddlewarePhase;
238```
239
240Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:55](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L55)
241
242Current lifecycle phase
243
244***
245
246### provider
247
248```ts
249provider: string;
250```
251
252Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:76](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L76)
253
254Provider name (e.g., 'openai', 'anthropic')
255
256***
257
258### requestId
259
260```ts
261requestId: string;
262```
263
264Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:38](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L38)
265
266Unique identifier for this chat request
267
268***
269
270### signal?
271
272```ts
273optional signal: AbortSignal;
274```
275
276Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:61](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L61)
277
278Abort signal from the chat request
279
280***
281
282### source
283
284```ts
285source: "client" | "server";
286```
287
288Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:80](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L80)
289
290Source of the chat invocation — always 'server' for server-side chat
291
292***
293
294### streamId
295
296```ts
297streamId: string;
298```
299
300Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:40](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L40)
301
302Unique identifier for this stream
303
304***
305
306### streaming
307
308```ts
309streaming: boolean;
310```
311
312Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:82](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L82)
313
314Whether the chat is streaming
315
316***
317
318### systemPrompts
319
320```ts
321systemPrompts: SystemPrompt[];
322```
323
324Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:87](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L87)
325
326System prompts configured for this chat
327
328***
329
330### threadId
331
332```ts
333threadId: string;
334```
335
336Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:47](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L47)
337
338AG-UI thread identifier — a stable per-conversation ID used to
339correlate client and server devtools events. Resolves to the
340caller-provided `threadId` (or legacy `conversationId`), or an
341auto-generated value when neither is supplied.
342
343***
344
345### toolNames?
346
347```ts
348optional toolNames: string[];
349```
350
351Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:89](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L89)
352
353Names of configured tools, if any