StructuredOutputStartEvent

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

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

Properties#

metadata?#

optional metadata?: Record<string, any>;

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

Inherited from#

CustomEvent.metadata

name#

name: "structured-output.start";

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

Overrides#

CustomEvent.name

type#

type: "CUSTOM";

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

Inherited from#

CustomEvent.type

value#

value: object;

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

messageId#

messageId: string;

Overrides#

CustomEvent.value