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

StructuredOutputMiddlewareConfig.md

152 lines4.4 KB

1---
2id: StructuredOutputMiddlewareConfig
3title: StructuredOutputMiddlewareConfig
4---
5​
6# Interface: StructuredOutputMiddlewareConfig
7​
8Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:151](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L151)
9​
10Config passed to onStructuredOutputConfig.
11​
12Extends ChatMiddlewareConfig with the outputSchema being sent to the
13provider. Middleware may transform the schema (e.g., inject $defs, strip
14vendor-incompatible keywords) by returning a partial that includes
15`outputSchema`.
16​
17Note: `tools` is structurally inherited from ChatMiddlewareConfig but is
18NOT forwarded to the structured-output adapter call — the final call is a
19single typed-response request, not an agentic loop. Returning a transformed
20`tools` array from onStructuredOutputConfig updates engine state but does
21not change what reaches the provider's structured-output endpoint.
22​
23## Extends
24​
25- [`ChatMiddlewareConfig`](ChatMiddlewareConfig.md)
26​
27## Properties
28​
29### maxTokens?
30​
31```ts
32optional maxTokens: number;
33```
34​
35Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:132](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L132)
36​
37#### Inherited from
38​
39[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`maxTokens`](ChatMiddlewareConfig.md#maxtokens)
40​
41***
42​
43### messages
44​
45```ts
46messages: ModelMessage<
47 | string
48 | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
49 | null>[];
50```
51​
52Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:127](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L127)
53​
54#### Inherited from
55​
56[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`messages`](ChatMiddlewareConfig.md#messages)
57​
58***
59​
60### metadata?
61​
62```ts
63optional metadata: Record<string, unknown>;
64```
65​
66Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:133](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L133)
67​
68#### Inherited from
69​
70[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`metadata`](ChatMiddlewareConfig.md#metadata)
71​
72***
73​
74### modelOptions?
75​
76```ts
77optional modelOptions: Record<string, unknown>;
78```
79​
80Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:134](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L134)
81​
82#### Inherited from
83​
84[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`modelOptions`](ChatMiddlewareConfig.md#modeloptions)
85​
86***
87​
88### outputSchema
89​
90```ts
91outputSchema: JSONSchema;
92```
93​
94Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:153](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L153)
95​
96JSON Schema being sent to the provider for structured output.
97​
98***
99​
100### systemPrompts
101​
102```ts
103systemPrompts: SystemPrompt[];
104```
105​
106Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:128](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L128)
107​
108#### Inherited from
109​
110[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`systemPrompts`](ChatMiddlewareConfig.md#systemprompts)
111​
112***
113​
114### temperature?
115​
116```ts
117optional temperature: number;
118```
119​
120Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:130](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L130)
121​
122#### Inherited from
123​
124[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`temperature`](ChatMiddlewareConfig.md#temperature)
125​
126***
127​
128### tools
129​
130```ts
131tools: Tool<SchemaInput, SchemaInput, string>[];
132```
133​
134Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:129](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L129)
135​
136#### Inherited from
137​
138[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`tools`](ChatMiddlewareConfig.md#tools)
139​
140***
141​
142### topP?
143​
144```ts
145optional topP: number;
146```
147​
148Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:131](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L131)
149​
150#### Inherited from
151​
152[`ChatMiddlewareConfig`](ChatMiddlewareConfig.md).[`topP`](ChatMiddlewareConfig.md#topp)