Open History to see the last commit
1---
2id: StructuredOutputMiddlewareConfig
3title: StructuredOutputMiddlewareConfig
4---
5
6# Interface: StructuredOutputMiddlewareConfig
7
8Defined in: [packages/ai/src/activities/chat/middleware/types.ts:225](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L225)
9
10Config passed to onStructuredOutputConfig.
11
12Mirrors ChatMiddlewareConfig minus `tools` (the final structured-output call
13is a single typed-response request, not an agentic loop — tools cannot be
14forwarded to it), plus the `outputSchema` being sent to the provider.
15Middleware may transform the schema (e.g., inject $defs, strip
16vendor-incompatible keywords) by returning a partial that includes
17`outputSchema`.
18
19## Extends
20
21- `Omit`\<[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md), `"tools"`\>
22
23## Properties
24
25### messages
26
27```ts
28messages: ModelMessage<
29 | string
30 | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
31 | null>[];
32```
33
34Defined in: [packages/ai/src/activities/chat/middleware/types.ts:208](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L208)
35
36#### Inherited from
37
38[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`messages`](ChatMiddlewareConfig.md#messages)
39
40***
41
42### metadata?
43
44```ts
45optional metadata: Record<string, unknown>;
46```
47
48Defined in: [packages/ai/src/activities/chat/middleware/types.ts:211](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L211)
49
50#### Inherited from
51
52[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`metadata`](ChatMiddlewareConfig.md#metadata)
53
54***
55
56### modelOptions?
57
58```ts
59optional modelOptions: Record<string, unknown>;
60```
61
62Defined in: [packages/ai/src/activities/chat/middleware/types.ts:212](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L212)
63
64#### Inherited from
65
66[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`modelOptions`](ChatMiddlewareConfig.md#modeloptions)
67
68***
69
70### outputSchema
71
72```ts
73outputSchema: JSONSchema;
74```
75
76Defined in: [packages/ai/src/activities/chat/middleware/types.ts:230](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L230)
77
78JSON Schema being sent to the provider for structured output.
79
80***
81
82### systemPrompts
83
84```ts
85systemPrompts: SystemPrompt[];
86```
87
88Defined in: [packages/ai/src/activities/chat/middleware/types.ts:209](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L209)
89
90#### Inherited from
91
92[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`systemPrompts`](ChatMiddlewareConfig.md#systemprompts)