0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/StructuredOutputStartEvent.md
github-actions[bot] 1999af2267
docs: regenerate API documentation (#1260)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-28 11:42:19 +02:00

1.6 KiB

id title
StructuredOutputStartEvent StructuredOutputStartEvent

Interface: StructuredOutputStartEvent

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

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

Properties

metadata?

optional metadata?: Record<string, any>;

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

Inherited from

CustomEvent.metadata


name

name: "structured-output.start";

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

Overrides

CustomEvent.name

type

type: "CUSTOM";

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

Inherited from

CustomEvent.type


value

value: object;

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

messageId

messageId: string;

Overrides

CustomEvent.value