Interfaces

OutputSchemaOptions

Interface: OutputSchemaOptions

Defined in: src/core/outputSchema.ts:77

Optional configuration for outputSchema.

Properties

instruction?

readonly optional instruction?: string

Defined in: src/core/outputSchema.ts:92

Custom system-prompt instruction text. Defaults to a generic "Respond with valid JSON matching the output schema. Do not include prose." sentence (extended with parser.description when present). Override when the LLM benefits from a domain-specific framing.


name?

readonly optional name?: string

Defined in: src/core/outputSchema.ts:84

Injection id for the auto-generated "respond with this shape" instruction. Defaults to 'output-schema'. Override when you have multiple agents with different schemas in one process and want the diagnostic events to disambiguate.

On this page