StructuredOutputMiddlewareConfig

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

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#

• Omit<ChatMiddlewareConfig, "tools">

Properties#

messages#

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

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

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:335

Inherited from#

ChatMiddlewareConfig.metadata

modelOptions?#

optional modelOptions?: Record<string, unknown>;

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

Inherited from#

ChatMiddlewareConfig.modelOptions

outputSchema#

outputSchema: JSONSchema;

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

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:330

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:333

Inherited from#

ChatMiddlewareConfig.resume

resumeToolState?#

optional resumeToolState?: ChatResumeToolState;

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

Inherited from#

ChatMiddlewareConfig.resumeToolState

systemPrompts#

systemPrompts: SystemPrompt[];

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

Inherited from#

ChatMiddlewareConfig.systemPrompts