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

RealtimeSessionConfig.md

142 lines2.9 KB

1---
2id: RealtimeSessionConfig
3title: RealtimeSessionConfig
4---
5​
6# Interface: RealtimeSessionConfig
7​
8Defined in: [packages/ai/src/realtime/types.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L35)
9​
10Configuration for a realtime session
11​
12## Properties
13​
14### instructions?
15​
16```ts
17optional instructions: string;
18```
19​
20Defined in: [packages/ai/src/realtime/types.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L41)
21​
22System instructions for the assistant
23​
24***
25​
26### maxOutputTokens?
27​
28```ts
29optional maxOutputTokens: number | "inf";
30```
31​
32Defined in: [packages/ai/src/realtime/types.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L53)
33​
34Maximum number of tokens in a response
35​
36***
37​
38### model?
39​
40```ts
41optional model: string;
42```
43​
44Defined in: [packages/ai/src/realtime/types.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L37)
45​
46Model to use for the session
47​
48***
49​
50### outputModalities?
51​
52```ts
53optional outputModalities: ("text" | "audio")[];
54```
55​
56Defined in: [packages/ai/src/realtime/types.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L49)
57​
58Output modalities for responses (e.g., ['audio', 'text'], ['text'])
59​
60***
61​
62### providerOptions?
63​
64```ts
65optional providerOptions: Record<string, any>;
66```
67​
68Defined in: [packages/ai/src/realtime/types.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L57)
69​
70Provider-specific options
71​
72***
73​
74### semanticEagerness?
75​
76```ts
77optional semanticEagerness: "high" | "low" | "medium";
78```
79​
80Defined in: [packages/ai/src/realtime/types.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L55)
81​
82Eagerness level for semantic VAD ('low', 'medium', 'high')
83​
84***
85​
86### temperature?
87​
88```ts
89optional temperature: number;
90```
91​
92Defined in: [packages/ai/src/realtime/types.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L51)
93​
94Temperature for generation (provider-specific range, e.g., 0.6-1.2 for OpenAI)
95​
96***
97​
98### tools?
99​
100```ts
101optional tools: RealtimeToolConfig[];
102```
103​
104Defined in: [packages/ai/src/realtime/types.ts:43](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L43)
105​
106Tools available in the session
107​
108***
109​
110### vadConfig?
111​
112```ts
113optional vadConfig: VADConfig;
114```
115​
116Defined in: [packages/ai/src/realtime/types.ts:47](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L47)
117​
118VAD configuration
119​
120***
121​
122### vadMode?
123​
124```ts
125optional vadMode: "server" | "manual" | "semantic";
126```
127​
128Defined in: [packages/ai/src/realtime/types.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L45)
129​
130VAD mode
131​
132***
133​
134### voice?
135​
136```ts
137optional voice: string;
138```
139​
140Defined in: [packages/ai/src/realtime/types.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L39)
141​
142Voice to use for audio output