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
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:315
Canonical conversation history. Middleware and persistence read this.
Inherited from
metadata?
optional metadata?: Record<string, unknown>;
Defined in: packages/ai/src/activities/chat/middleware/types.ts:322
Inherited from
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
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