Class StructuredOutputManager

Structured Output Manager implementation.

Provides comprehensive structured output capabilities including:

JSON Schema validation with detailed error reporting
Multiple generation strategies (JSON mode, function calling, prompt engineering)
Automatic retry with feedback on validation failures
Parallel function calling with argument validation
Entity extraction from unstructured text
Robust JSON parsing with error recovery

Implements

Implements

IStructuredOutputManager

Index

Constructors

Methods

initialize generate generateFunctionCalls extractEntities validate parseJSON recommendStrategy registerSchema getSchema getStatistics resetStatistics

Constructors

constructor

new StructuredOutputManager(config): StructuredOutputManager
Creates a new StructuredOutputManager instance.
Parameters
- config: StructuredOutputManagerConfig
  Configuration options
Returns StructuredOutputManager
- Defined in core/structured/StructuredOutputManager.ts:182

Methods

initialize

initialize(logger?): Promise<void>
Initializes the manager.
Parameters
- Optional logger: ILogger
Returns Promise<void>
Implementation of IStructuredOutputManager.initialize
- Defined in core/structured/StructuredOutputManager.ts:194

generate

generate<T>(options): Promise<StructuredGenerationResult<T>>
Generates structured output conforming to the given schema.
Type Parameters
- T = unknown
Parameters
- options: StructuredGenerationOptions
Returns Promise<StructuredGenerationResult<T>>
Implementation of IStructuredOutputManager.generate
- Defined in core/structured/StructuredOutputManager.ts:202

generateFunctionCalls

generateFunctionCalls(options): Promise<ParallelFunctionCallResult>
Generates parallel function/tool calls.
Parameters
- options: ParallelFunctionCallOptions
Returns Promise<ParallelFunctionCallResult>
Implementation of IStructuredOutputManager.generateFunctionCalls
- Defined in core/structured/StructuredOutputManager.ts:475

extractEntities

extractEntities<T>(options): Promise<EntityExtractionResult<T>>
Extracts structured entities from unstructured text.
Type Parameters
- T = unknown
Parameters
- options: EntityExtractionOptions
Returns Promise<EntityExtractionResult<T>>
Implementation of IStructuredOutputManager.extractEntities
- Defined in core/structured/StructuredOutputManager.ts:567

validate

validate(data, schema, strict?): ValidationIssue[]
Validates data against a JSON Schema.
Parameters
- data: unknown
- schema: JSONSchema
- Optional strict: boolean
Returns ValidationIssue[]
Implementation of IStructuredOutputManager.validate
- Defined in core/structured/StructuredOutputManager.ts:651

parseJSON

parseJSON(jsonString): unknown
Parses JSON string with error recovery.
Parameters
- jsonString: string
Returns unknown
Implementation of IStructuredOutputManager.parseJSON
- Defined in core/structured/StructuredOutputManager.ts:1074

recommendStrategy

recommendStrategy(providerId, modelId, schema): StructuredOutputStrategy
Recommends a strategy for the given provider/model.
Parameters
- providerId: string
- modelId: string
- schema: JSONSchema
Returns StructuredOutputStrategy
Implementation of IStructuredOutputManager.recommendStrategy
- Defined in core/structured/StructuredOutputManager.ts:1125

registerSchema

registerSchema(name, schema): void
Registers a schema for reuse.
Parameters
- name: string
- schema: JSONSchema
Returns void
Implementation of IStructuredOutputManager.registerSchema
- Defined in core/structured/StructuredOutputManager.ts:1156

getSchema

getSchema(name): undefined | JSONSchema
Gets a registered schema.
Parameters
- name: string
Returns undefined | JSONSchema
Implementation of IStructuredOutputManager.getSchema
- Defined in core/structured/StructuredOutputManager.ts:1164

getStatistics

getStatistics(): StructuredOutputStats
Gets statistics about structured output operations.

Returns StructuredOutputStats
Implementation of IStructuredOutputManager.getStatistics
- Defined in core/structured/StructuredOutputManager.ts:1171

resetStatistics

resetStatistics(): void
Resets statistics.

Returns void
Implementation of IStructuredOutputManager.resetStatistics
- Defined in core/structured/StructuredOutputManager.ts:1178