vapi-client 0.4.2

Unofficial crate for Vapi - Voice AI for developers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253

/*
 * Vapi API
 *
 * Voice AI for developers.
 *
 * The version of the OpenAPI document: 1.0
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct WorkflowOpenAiModel {
    /// This is the provider of the model (`openai`).
    #[serde(rename = "provider")]
    pub provider: ProviderTrue,
    /// This is the OpenAI model that will be used.  When using Vapi OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest region that make sense. This is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/.
    #[serde(rename = "model")]
    pub model: ModelTrue,
    /// This is the temperature of the model.
    #[serde(rename = "temperature", skip_serializing_if = "Option::is_none")]
    pub temperature: Option<f64>,
    /// This is the max tokens of the model.
    #[serde(rename = "maxTokens", skip_serializing_if = "Option::is_none")]
    pub max_tokens: Option<f64>,
}

impl WorkflowOpenAiModel {
    pub fn new(provider: ProviderTrue, model: ModelTrue) -> WorkflowOpenAiModel {
        WorkflowOpenAiModel {
            provider,
            model,
            temperature: None,
            max_tokens: None,
        }
    }
}
/// This is the provider of the model (`openai`).
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum ProviderTrue {
    #[serde(rename = "openai")]
    Openai,
}

impl Default for ProviderTrue {
    fn default() -> ProviderTrue {
        Self::Openai
    }
}
/// This is the OpenAI model that will be used.  When using Vapi OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest region that make sense. This is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum ModelTrue {
    #[serde(rename = "gpt-4.1-2025-04-14")]
    Gpt4Period120250414,
    #[serde(rename = "gpt-4.1-mini-2025-04-14")]
    Gpt4Period1Mini20250414,
    #[serde(rename = "gpt-4.1-nano-2025-04-14")]
    Gpt4Period1Nano20250414,
    #[serde(rename = "gpt-4.1")]
    Gpt4Period1,
    #[serde(rename = "gpt-4.1-mini")]
    Gpt4Period1Mini,
    #[serde(rename = "gpt-4.1-nano")]
    Gpt4Period1Nano,
    #[serde(rename = "gpt-4.5-preview")]
    Gpt4Period5Preview,
    #[serde(rename = "chatgpt-4o-latest")]
    Chatgpt4oLatest,
    #[serde(rename = "o3")]
    O3,
    #[serde(rename = "o3-mini")]
    O3Mini,
    #[serde(rename = "o4-mini")]
    O4Mini,
    #[serde(rename = "o1-preview")]
    O1Preview,
    #[serde(rename = "o1-preview-2024-09-12")]
    O1Preview20240912,
    #[serde(rename = "o1-mini")]
    O1Mini,
    #[serde(rename = "o1-mini-2024-09-12")]
    O1Mini20240912,
    #[serde(rename = "gpt-4o-realtime-preview-2024-10-01")]
    Gpt4oRealtimePreview20241001,
    #[serde(rename = "gpt-4o-realtime-preview-2024-12-17")]
    Gpt4oRealtimePreview20241217,
    #[serde(rename = "gpt-4o-mini-realtime-preview-2024-12-17")]
    Gpt4oMiniRealtimePreview20241217,
    #[serde(rename = "gpt-4o-mini-2024-07-18")]
    Gpt4oMini20240718,
    #[serde(rename = "gpt-4o-mini")]
    Gpt4oMini,
    #[serde(rename = "gpt-4o")]
    Gpt4o,
    #[serde(rename = "gpt-4o-2024-05-13")]
    Gpt4o20240513,
    #[serde(rename = "gpt-4o-2024-08-06")]
    Gpt4o20240806,
    #[serde(rename = "gpt-4o-2024-11-20")]
    Gpt4o20241120,
    #[serde(rename = "gpt-4-turbo")]
    Gpt4Turbo,
    #[serde(rename = "gpt-4-turbo-2024-04-09")]
    Gpt4Turbo20240409,
    #[serde(rename = "gpt-4-turbo-preview")]
    Gpt4TurboPreview,
    #[serde(rename = "gpt-4-0125-preview")]
    Gpt40125Preview,
    #[serde(rename = "gpt-4-1106-preview")]
    Gpt41106Preview,
    #[serde(rename = "gpt-4")]
    Gpt4,
    #[serde(rename = "gpt-4-0613")]
    Gpt40613,
    #[serde(rename = "gpt-3.5-turbo")]
    Gpt3Period5Turbo,
    #[serde(rename = "gpt-3.5-turbo-0125")]
    Gpt3Period5Turbo0125,
    #[serde(rename = "gpt-3.5-turbo-1106")]
    Gpt3Period5Turbo1106,
    #[serde(rename = "gpt-3.5-turbo-16k")]
    Gpt3Period5Turbo16k,
    #[serde(rename = "gpt-3.5-turbo-0613")]
    Gpt3Period5Turbo0613,
    #[serde(rename = "gpt-4.1-2025-04-14:westus")]
    Gpt4Period120250414ColonWestus,
    #[serde(rename = "gpt-4.1-2025-04-14:eastus2")]
    Gpt4Period120250414ColonEastus2,
    #[serde(rename = "gpt-4.1-2025-04-14:eastus")]
    Gpt4Period120250414ColonEastus,
    #[serde(rename = "gpt-4.1-2025-04-14:westus3")]
    Gpt4Period120250414ColonWestus3,
    #[serde(rename = "gpt-4.1-2025-04-14:northcentralus")]
    Gpt4Period120250414ColonNorthcentralus,
    #[serde(rename = "gpt-4.1-2025-04-14:southcentralus")]
    Gpt4Period120250414ColonSouthcentralus,
    #[serde(rename = "gpt-4.1-mini-2025-04-14:westus")]
    Gpt4Period1Mini20250414ColonWestus,
    #[serde(rename = "gpt-4.1-mini-2025-04-14:eastus2")]
    Gpt4Period1Mini20250414ColonEastus2,
    #[serde(rename = "gpt-4.1-mini-2025-04-14:eastus")]
    Gpt4Period1Mini20250414ColonEastus,
    #[serde(rename = "gpt-4.1-mini-2025-04-14:westus3")]
    Gpt4Period1Mini20250414ColonWestus3,
    #[serde(rename = "gpt-4.1-mini-2025-04-14:northcentralus")]
    Gpt4Period1Mini20250414ColonNorthcentralus,
    #[serde(rename = "gpt-4.1-mini-2025-04-14:southcentralus")]
    Gpt4Period1Mini20250414ColonSouthcentralus,
    #[serde(rename = "gpt-4.1-nano-2025-04-14:westus")]
    Gpt4Period1Nano20250414ColonWestus,
    #[serde(rename = "gpt-4.1-nano-2025-04-14:eastus2")]
    Gpt4Period1Nano20250414ColonEastus2,
    #[serde(rename = "gpt-4.1-nano-2025-04-14:westus3")]
    Gpt4Period1Nano20250414ColonWestus3,
    #[serde(rename = "gpt-4.1-nano-2025-04-14:northcentralus")]
    Gpt4Period1Nano20250414ColonNorthcentralus,
    #[serde(rename = "gpt-4.1-nano-2025-04-14:southcentralus")]
    Gpt4Period1Nano20250414ColonSouthcentralus,
    #[serde(rename = "gpt-4o-2024-11-20:swedencentral")]
    Gpt4o20241120ColonSwedencentral,
    #[serde(rename = "gpt-4o-2024-11-20:westus")]
    Gpt4o20241120ColonWestus,
    #[serde(rename = "gpt-4o-2024-11-20:eastus2")]
    Gpt4o20241120ColonEastus2,
    #[serde(rename = "gpt-4o-2024-11-20:eastus")]
    Gpt4o20241120ColonEastus,
    #[serde(rename = "gpt-4o-2024-11-20:westus3")]
    Gpt4o20241120ColonWestus3,
    #[serde(rename = "gpt-4o-2024-11-20:southcentralus")]
    Gpt4o20241120ColonSouthcentralus,
    #[serde(rename = "gpt-4o-2024-08-06:westus")]
    Gpt4o20240806ColonWestus,
    #[serde(rename = "gpt-4o-2024-08-06:westus3")]
    Gpt4o20240806ColonWestus3,
    #[serde(rename = "gpt-4o-2024-08-06:eastus")]
    Gpt4o20240806ColonEastus,
    #[serde(rename = "gpt-4o-2024-08-06:eastus2")]
    Gpt4o20240806ColonEastus2,
    #[serde(rename = "gpt-4o-2024-08-06:northcentralus")]
    Gpt4o20240806ColonNorthcentralus,
    #[serde(rename = "gpt-4o-2024-08-06:southcentralus")]
    Gpt4o20240806ColonSouthcentralus,
    #[serde(rename = "gpt-4o-mini-2024-07-18:westus")]
    Gpt4oMini20240718ColonWestus,
    #[serde(rename = "gpt-4o-mini-2024-07-18:westus3")]
    Gpt4oMini20240718ColonWestus3,
    #[serde(rename = "gpt-4o-mini-2024-07-18:eastus")]
    Gpt4oMini20240718ColonEastus,
    #[serde(rename = "gpt-4o-mini-2024-07-18:eastus2")]
    Gpt4oMini20240718ColonEastus2,
    #[serde(rename = "gpt-4o-mini-2024-07-18:northcentralus")]
    Gpt4oMini20240718ColonNorthcentralus,
    #[serde(rename = "gpt-4o-mini-2024-07-18:southcentralus")]
    Gpt4oMini20240718ColonSouthcentralus,
    #[serde(rename = "gpt-4o-2024-05-13:eastus2")]
    Gpt4o20240513ColonEastus2,
    #[serde(rename = "gpt-4o-2024-05-13:eastus")]
    Gpt4o20240513ColonEastus,
    #[serde(rename = "gpt-4o-2024-05-13:northcentralus")]
    Gpt4o20240513ColonNorthcentralus,
    #[serde(rename = "gpt-4o-2024-05-13:southcentralus")]
    Gpt4o20240513ColonSouthcentralus,
    #[serde(rename = "gpt-4o-2024-05-13:westus3")]
    Gpt4o20240513ColonWestus3,
    #[serde(rename = "gpt-4o-2024-05-13:westus")]
    Gpt4o20240513ColonWestus,
    #[serde(rename = "gpt-4-turbo-2024-04-09:eastus2")]
    Gpt4Turbo20240409ColonEastus2,
    #[serde(rename = "gpt-4-0125-preview:eastus")]
    Gpt40125PreviewColonEastus,
    #[serde(rename = "gpt-4-0125-preview:northcentralus")]
    Gpt40125PreviewColonNorthcentralus,
    #[serde(rename = "gpt-4-0125-preview:southcentralus")]
    Gpt40125PreviewColonSouthcentralus,
    #[serde(rename = "gpt-4-1106-preview:australia")]
    Gpt41106PreviewColonAustralia,
    #[serde(rename = "gpt-4-1106-preview:canadaeast")]
    Gpt41106PreviewColonCanadaeast,
    #[serde(rename = "gpt-4-1106-preview:france")]
    Gpt41106PreviewColonFrance,
    #[serde(rename = "gpt-4-1106-preview:india")]
    Gpt41106PreviewColonIndia,
    #[serde(rename = "gpt-4-1106-preview:norway")]
    Gpt41106PreviewColonNorway,
    #[serde(rename = "gpt-4-1106-preview:swedencentral")]
    Gpt41106PreviewColonSwedencentral,
    #[serde(rename = "gpt-4-1106-preview:uk")]
    Gpt41106PreviewColonUk,
    #[serde(rename = "gpt-4-1106-preview:westus")]
    Gpt41106PreviewColonWestus,
    #[serde(rename = "gpt-4-1106-preview:westus3")]
    Gpt41106PreviewColonWestus3,
    #[serde(rename = "gpt-4-0613:canadaeast")]
    Gpt40613ColonCanadaeast,
    #[serde(rename = "gpt-3.5-turbo-0125:canadaeast")]
    Gpt3Period5Turbo0125ColonCanadaeast,
    #[serde(rename = "gpt-3.5-turbo-0125:northcentralus")]
    Gpt3Period5Turbo0125ColonNorthcentralus,
    #[serde(rename = "gpt-3.5-turbo-0125:southcentralus")]
    Gpt3Period5Turbo0125ColonSouthcentralus,
    #[serde(rename = "gpt-3.5-turbo-1106:canadaeast")]
    Gpt3Period5Turbo1106ColonCanadaeast,
    #[serde(rename = "gpt-3.5-turbo-1106:westus")]
    Gpt3Period5Turbo1106ColonWestus,
}

impl Default for ModelTrue {
    fn default() -> ModelTrue {
        Self::Gpt4Period120250414
    }
}