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

GenerationMiddlewareContext.md

131 lines3.1 KB

1---
2id: GenerationMiddlewareContext
3title: GenerationMiddlewareContext
4---
5​
6# Interface: GenerationMiddlewareContext\<TContext\>
7​
8Defined in: [packages/ai/src/activities/middleware/types.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L51)
9​
10Stable context passed to every [GenerationMiddleware](GenerationMiddleware.md) hook. Created
11once per activity call and shared across the hooks of that call.
12​
13Carries only fields every activity can honor. `ChatMiddlewareContext`
14structurally includes all of these plus chat-only state (messages,
15iteration, capabilities, …), which is why a chat middleware that reads those
16extra fields is not assignable to `GenerationMiddleware`.
17​
18## Type Parameters
19​
20### TContext
21​
22`TContext` = `unknown`
23​
24## Properties
25​
26### activity
27​
28```ts
29activity: GenerationActivity;
30```
31​
32Defined in: [packages/ai/src/activities/middleware/types.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L58)
33​
34Which activity this call is. Discriminates media from chat.
35​
36***
37​
38### context
39​
40```ts
41context: TContext;
42```
43​
44Defined in: [packages/ai/src/activities/middleware/types.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L74)
45​
46Runtime context provided by the activity options, if any.
47​
48***
49​
50### createId()
51​
52```ts
53createId: (prefix) => string;
54```
55​
56Defined in: [packages/ai/src/activities/middleware/types.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L72)
57​
58Generate a unique id with the given prefix.
59​
60#### Parameters
61​
62##### prefix
63​
64`string`
65​
66#### Returns
67​
68`string`
69​
70***
71​
72### model
73​
74```ts
75model: string;
76```
77​
78Defined in: [packages/ai/src/activities/middleware/types.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L62)
79​
80Model id. Emitted as `gen_ai.request.model`.
81​
82***
83​
84### modelOptions?
85​
86```ts
87optional modelOptions: unknown;
88```
89​
90Defined in: [packages/ai/src/activities/middleware/types.ts:68](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L68)
91​
92Provider-specific options passed to the activity, if any. Typed `unknown`
93because each activity's options are strongly typed per model; a supertype
94of `ChatMiddlewareContext`'s `modelOptions`.
95​
96***
97​
98### provider
99​
100```ts
101provider: string;
102```
103​
104Defined in: [packages/ai/src/activities/middleware/types.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L60)
105​
106Provider/adapter name (e.g. `"openai"`). Emitted as `gen_ai.system`.
107​
108***
109​
110### requestId
111​
112```ts
113requestId: string;
114```
115​
116Defined in: [packages/ai/src/activities/middleware/types.ts:56](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L56)
117​
118Stable id correlating the `onStart` / `onFinish` / `onError` / `onAbort`
119hooks of a single activity call.
120​
121***
122​
123### source
124​
125```ts
126source: "server" | "client";
127```
128​
129Defined in: [packages/ai/src/activities/middleware/types.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L70)
130​
131Where the call originates. Always `'server'` for media activities.