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

StructuredOutputMiddlewareConfig.md

134 lines3.6 KB

Interface: StructuredOutputMiddlewareConfig

Defined in: packages/ai/src/activities/chat/middleware/types.ts:150

Config passed to onStructuredOutputConfig.

Mirrors ChatMiddlewareConfig minus tools (the final structured-output call is a single typed-response request, not an agentic loop — tools cannot be forwarded to it), plus the outputSchema being sent to the provider. Middleware may transform the schema (e.g., inject $defs, strip vendor-incompatible keywords) by returning a partial that includes outputSchema.

Extends

Properties

maxTokens?

optional maxTokens: number;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:135

Inherited from

ChatMiddlewareConfig.maxTokens


messages

messages: ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
  | null>[];

Defined in: packages/ai/src/activities/chat/middleware/types.ts:130

Inherited from

ChatMiddlewareConfig.messages


metadata?

optional metadata: Record<string, unknown>;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:136

Inherited from

ChatMiddlewareConfig.metadata


modelOptions?

optional modelOptions: Record<string, unknown>;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:137

Inherited from

ChatMiddlewareConfig.modelOptions


outputSchema

outputSchema: JSONSchema;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:155

JSON Schema being sent to the provider for structured output.


systemPrompts

systemPrompts: SystemPrompt[];

Defined in: packages/ai/src/activities/chat/middleware/types.ts:131

Inherited from

ChatMiddlewareConfig.systemPrompts


temperature?

optional temperature: number;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:133

Inherited from

ChatMiddlewareConfig.temperature


topP?

optional topP: number;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:134

Inherited from

ChatMiddlewareConfig.topP