0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/StructuredOutputMiddlewareConfig.md
github-actions[bot] 273a212bcc
docs: regenerate API documentation (#1265)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-31 18:34:13 +02:00

3.9 KiB

id title
StructuredOutputMiddlewareConfig StructuredOutputMiddlewareConfig

Interface: StructuredOutputMiddlewareConfig

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

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

messages

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

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

Canonical conversation history. Middleware and persistence read this.

Inherited from

ChatMiddlewareConfig.messages


metadata?

optional metadata?: Record<string, unknown>;

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

Inherited from

ChatMiddlewareConfig.metadata


modelOptions?

optional modelOptions?: Record<string, unknown>;

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

Inherited from

ChatMiddlewareConfig.modelOptions


outputSchema

outputSchema: JSONSchema;

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

JSON Schema being sent to the provider for structured output.


providerMessages?

optional providerMessages?: ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
  | null>[];

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

Provider-only context. Defaults to messages when it is not set.

Inherited from

ChatMiddlewareConfig.providerMessages


resume?

optional resume?: RunAgentResumeItem[];

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

Inherited from

ChatMiddlewareConfig.resume


resumeToolState?

optional resumeToolState?: ChatResumeToolState;

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

Inherited from

ChatMiddlewareConfig.resumeToolState


systemPrompts

systemPrompts: SystemPrompt[];

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

Inherited from

ChatMiddlewareConfig.systemPrompts