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

RealtimeEventPayloads.md

168 lines2.5 KB

1---
2id: RealtimeEventPayloads
3title: RealtimeEventPayloads
4---
5​
6# Interface: RealtimeEventPayloads
7​
8Defined in: [packages/typescript/ai/src/realtime/types.ts:251](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L251)
9​
10Event payloads for realtime events
11​
12## Properties
13​
14### audio\_chunk
15​
16```ts
17audio_chunk: object;
18```
19​
20Defined in: [packages/typescript/ai/src/realtime/types.ts:259](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L259)
21​
22#### data
23​
24```ts
25data: ArrayBuffer;
26```
27​
28#### sampleRate
29​
30```ts
31sampleRate: number;
32```
33​
34***
35​
36### error
37​
38```ts
39error: object;
40```
41​
42Defined in: [packages/typescript/ai/src/realtime/types.ts:263](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L263)
43​
44#### error
45​
46```ts
47error: Error;
48```
49​
50***
51​
52### interrupted
53​
54```ts
55interrupted: object;
56```
57​
58Defined in: [packages/typescript/ai/src/realtime/types.ts:262](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L262)
59​
60#### messageId?
61​
62```ts
63optional messageId: string;
64```
65​
66***
67​
68### message\_complete
69​
70```ts
71message_complete: object;
72```
73​
74Defined in: [packages/typescript/ai/src/realtime/types.ts:261](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L261)
75​
76#### message
77​
78```ts
79message: RealtimeMessage;
80```
81​
82***
83​
84### mode\_change
85​
86```ts
87mode_change: object;
88```
89​
90Defined in: [packages/typescript/ai/src/realtime/types.ts:253](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L253)
91​
92#### mode
93​
94```ts
95mode: RealtimeMode;
96```
97​
98***
99​
100### status\_change
101​
102```ts
103status_change: object;
104```
105​
106Defined in: [packages/typescript/ai/src/realtime/types.ts:252](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L252)
107​
108#### status
109​
110```ts
111status: RealtimeStatus;
112```
113​
114***
115​
116### tool\_call
117​
118```ts
119tool_call: object;
120```
121​
122Defined in: [packages/typescript/ai/src/realtime/types.ts:260](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L260)
123​
124#### input
125​
126```ts
127input: unknown;
128```
129​
130#### toolCallId
131​
132```ts
133toolCallId: string;
134```
135​
136#### toolName
137​
138```ts
139toolName: string;
140```
141​
142***
143​
144### transcript
145​
146```ts
147transcript: object;
148```
149​
150Defined in: [packages/typescript/ai/src/realtime/types.ts:254](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L254)
151​
152#### isFinal
153​
154```ts
155isFinal: boolean;
156```
157​
158#### role
159​
160```ts
161role: "user" | "assistant";
162```
163​
164#### transcript
165​
166```ts
167transcript: string;
168```