Skip to main content

Interface: StructuredGenerationOptions

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:221

Options for structured output generation.

Properties

customValidator()?

optional customValidator: (data) => ValidationIssue[]

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:265

Custom validation function for additional checks

Parameters

data

unknown

Returns

ValidationIssue[]


includeReasoning?

optional includeReasoning: boolean

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:253

Whether to include reasoning/chain-of-thought before output


maxRetries?

optional maxRetries: number

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:250

Number of retry attempts on validation failure


maxTokens?

optional maxTokens: number

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:247

Maximum tokens to generate


modelId?

optional modelId: string

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:241

Model ID to use


prompt

prompt: string | object[]

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:223

The prompt or messages to send to the LLM


providerId?

optional providerId: string

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:238

LLM provider to use


schema

schema: JSONSchema

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:226

JSON Schema the output must conform to


schemaDescription?

optional schemaDescription: string

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:232

Description of what output is expected


schemaName

schemaName: string

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:229

Human-readable name for the schema (used in function calling)


strategy?

optional strategy: StructuredOutputStrategy

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:235

Strategy for enforcing structure


strict?

optional strict: boolean

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:262

Whether to strictly enforce schema (fail on extra properties)


systemPrompt?

optional systemPrompt: string

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:256

Custom system prompt to prepend


temperature?

optional temperature: number

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:244

Temperature for generation (0-2)


timeoutMs?

optional timeoutMs: number

Defined in: packages/agentos/src/core/structured/IStructuredOutputManager.ts:259

Timeout in milliseconds