Interface: StructuredOutputCompleteEvent<T>#
Defined in: packages/ai/src/types.ts:1360
Final event of a streaming structured-output run. Carries the validated
object (typed as T after the orchestrator runs Standard Schema parsing),
the raw JSON text that produced it, and — for thinking/reasoning models —
the accumulated reasoning text. Adapters emit this with T = unknown; the
chat orchestrator narrows to the schema's inferred type after validation.
reasoning is undefined when the model produced none (most non-thinking
models) and when the underlying adapter doesn't expose reasoning streams.
name is a string literal so consumers can narrow directly:
if (chunk.type === 'CUSTOM' && chunk.name === 'structured-output.complete') {
chunk.value.object // typed as T
}
Extends#
Type Parameters#
T#
T = unknown
Indexable#
[k: string]: unknown
Properties#
model?#
optional model: string;
Defined in: packages/ai/src/types.ts:1339
Model identifier for multi-model support
Inherited from#
name#
name: "structured-output.complete";
Defined in: packages/ai/src/types.ts:1363
Overrides#
CustomEvent.name
value#
value: object;
Defined in: packages/ai/src/types.ts:1364
object#
object: T;
raw#
raw: string;
reasoning?#
optional reasoning: string;
Overrides#
CustomEvent.value