Interface: StructuredOutputStartEvent#

Defined in: packages/ai/src/types.ts:1375

Emitted at the start of a streaming structured-output run, before the JSON deltas. Tells consumers that the upcoming TEXT_MESSAGE_CONTENT deltas belong to a structured response so they can route those bytes into a StructuredOutputPart instead of building a TextPart. Carries the messageId the deltas will be tagged with so the routing decision can be made per-message rather than globally.

Extends#

• CustomEvent

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#

CustomEvent.model

name#

name: "structured-output.start";

Defined in: packages/ai/src/types.ts:1376

Overrides#

CustomEvent.name

value#

value: object;

Defined in: packages/ai/src/types.ts:1377

messageId#

messageId: string;

Overrides#

CustomEvent.value