Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

StructuredOutputStartEvent.md

79 lines1.6 KB

1---
2id: StructuredOutputStartEvent
3title: StructuredOutputStartEvent
4---
5​
6# Interface: StructuredOutputStartEvent
7​
8Defined in: [packages/typescript/ai/src/types.ts:1183](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1183)
9​
10Emitted at the start of a streaming structured-output run, before the JSON
11deltas. Tells consumers that the upcoming `TEXT_MESSAGE_CONTENT` deltas
12belong to a structured response so they can route those bytes into a
13`StructuredOutputPart` instead of building a `TextPart`. Carries the
14`messageId` the deltas will be tagged with so the routing decision can be
15made per-message rather than globally.
16​
17## Extends
18​
19- [`CustomEvent`](CustomEvent.md)
20​
21## Indexable
22​
23```ts
24[k: string]: unknown
25```
26​
27## Properties
28​
29### model?
30​
31```ts
32optional model: string;
33```
34​
35Defined in: [packages/typescript/ai/src/types.ts:1147](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1147)
36​
37Model identifier for multi-model support
38​
39#### Inherited from
40​
41[`CustomEvent`](CustomEvent.md).[`model`](CustomEvent.md#model)
42​
43***
44​
45### name
46​
47```ts
48name: "structured-output.start";
49```
50​
51Defined in: [packages/typescript/ai/src/types.ts:1184](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1184)
52​
53#### Overrides
54​
55```ts
56CustomEvent.name
57```
58​
59***
60​
61### value
62​
63```ts
64value: object;
65```
66​
67Defined in: [packages/typescript/ai/src/types.ts:1185](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1185)
68​
69#### messageId
70​
71```ts
72messageId: string;
73```
74​
75#### Overrides
76​
77```ts
78CustomEvent.value
79```