Skip to main content

Class: StructuredOutputManager

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:144

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​

Constructors​

Constructor​

new StructuredOutputManager(config): StructuredOutputManager

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:182

Creates a new StructuredOutputManager instance.

Parameters​

config​

StructuredOutputManagerConfig

Configuration options

Returns​

StructuredOutputManager

Methods​

extractEntities()​

extractEntities<T>(options): Promise<EntityExtractionResult<T>>

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:567

Extracts structured entities from unstructured text.

Type Parameters​

T​

T = unknown

Parameters​

options​

EntityExtractionOptions

Returns​

Promise<EntityExtractionResult<T>>

Implementation of​

IStructuredOutputManager.extractEntities

generate()​

generate<T>(options): Promise<StructuredGenerationResult<T>>

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:202

Generates structured output conforming to the given schema.

Type Parameters​

T​

T = unknown

Parameters​

options​

StructuredGenerationOptions

Returns​

Promise<StructuredGenerationResult<T>>

Implementation of​

IStructuredOutputManager.generate

generateFunctionCalls()​

generateFunctionCalls(options): Promise<ParallelFunctionCallResult>

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:475

Generates parallel function/tool calls.

Parameters​

options​

ParallelFunctionCallOptions

Returns​

Promise<ParallelFunctionCallResult>

Implementation of​

IStructuredOutputManager.generateFunctionCalls

getSchema()​

getSchema(name): JSONSchema | undefined

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:1164

Gets a registered schema.

Parameters​

name​

string

Returns​

JSONSchema | undefined

Implementation of​

IStructuredOutputManager.getSchema

getStatistics()​

getStatistics(): StructuredOutputStats

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:1171

Gets statistics about structured output operations.

Returns​

StructuredOutputStats

Implementation of​

IStructuredOutputManager.getStatistics

initialize()​

initialize(logger?): Promise<void>

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:194

Initializes the manager.

Parameters​

logger?​

ILogger

Returns​

Promise<void>

Implementation of​

IStructuredOutputManager.initialize

parseJSON()​

parseJSON(jsonString): unknown

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:1074

Parses JSON string with error recovery.

Parameters​

jsonString​

string

Returns​

unknown

Implementation of​

IStructuredOutputManager.parseJSON

recommendStrategy()​

recommendStrategy(providerId, modelId, schema): StructuredOutputStrategy

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:1125

Recommends a strategy for the given provider/model.

Parameters​

providerId​

string

modelId​

string

schema​

JSONSchema

Returns​

StructuredOutputStrategy

Implementation of​

IStructuredOutputManager.recommendStrategy

registerSchema()​

registerSchema(name, schema): void

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:1156

Registers a schema for reuse.

Parameters​

name​

string

schema​

JSONSchema

Returns​

void

Implementation of​

IStructuredOutputManager.registerSchema

resetStatistics()​

resetStatistics(): void

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:1178

Resets statistics.

Returns​

void

Implementation of​

IStructuredOutputManager.resetStatistics

validate()​

validate(data, schema, strict?): ValidationIssue[]

Defined in: packages/agentos/src/api/structured/output/StructuredOutputManager.ts:651

Validates data against a JSON Schema.

Parameters​

data​

unknown

schema​

JSONSchema

strict?​

boolean

Returns​

ValidationIssue[]

Implementation of​

IStructuredOutputManager.validate