vapi_client/models/
assistant_overrides.rs

1/*
2 * Vapi API
3 *
4 * Voice AI for developers.
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct AssistantOverrides {
16    #[serde(rename = "transcriber", skip_serializing_if = "Option::is_none")]
17    pub transcriber: Option<models::CreateAssistantDtoTranscriber>,
18    #[serde(rename = "model", skip_serializing_if = "Option::is_none")]
19    pub model: Option<models::CreateAssistantDtoModel>,
20    #[serde(rename = "voice", skip_serializing_if = "Option::is_none")]
21    pub voice: Option<models::CreateAssistantDtoVoice>,
22    /// This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).  If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
23    #[serde(rename = "firstMessage", skip_serializing_if = "Option::is_none")]
24    pub first_message: Option<String>,
25    #[serde(
26        rename = "firstMessageInterruptionsEnabled",
27        skip_serializing_if = "Option::is_none"
28    )]
29    pub first_message_interruptions_enabled: Option<bool>,
30    /// This is the mode for the first message. Default is 'assistant-speaks-first'.  Use: - 'assistant-speaks-first' to have the assistant speak first. - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).  @default 'assistant-speaks-first'
31    #[serde(rename = "firstMessageMode", skip_serializing_if = "Option::is_none")]
32    pub first_message_mode: Option<FirstMessageModeTrue>,
33    #[serde(rename = "voicemailDetection", skip_serializing_if = "Option::is_none")]
34    pub voicemail_detection: Option<models::CreateAssistantDtoVoicemailDetection>,
35    /// These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.
36    #[serde(rename = "clientMessages", skip_serializing_if = "Option::is_none")]
37    pub client_messages: Option<Vec<ClientMessagesTrue>>,
38    /// These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.
39    #[serde(rename = "serverMessages", skip_serializing_if = "Option::is_none")]
40    pub server_messages: Option<Vec<ServerMessagesTrue>>,
41    /// How many seconds of silence to wait before ending the call. Defaults to 30.  @default 30
42    #[serde(
43        rename = "silenceTimeoutSeconds",
44        skip_serializing_if = "Option::is_none"
45    )]
46    pub silence_timeout_seconds: Option<f64>,
47    /// This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.  @default 600 (10 minutes)
48    #[serde(rename = "maxDurationSeconds", skip_serializing_if = "Option::is_none")]
49    pub max_duration_seconds: Option<f64>,
50    #[serde(rename = "backgroundSound", skip_serializing_if = "Option::is_none")]
51    pub background_sound: Option<models::CreateAssistantDtoBackgroundSound>,
52    /// This enables filtering of noise and background speech while the user is talking.  Default `false` while in beta.  @default false
53    #[serde(
54        rename = "backgroundDenoisingEnabled",
55        skip_serializing_if = "Option::is_none"
56    )]
57    pub background_denoising_enabled: Option<bool>,
58    /// This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.  Default `false` while in beta.  @default false
59    #[serde(
60        rename = "modelOutputInMessagesEnabled",
61        skip_serializing_if = "Option::is_none"
62    )]
63    pub model_output_in_messages_enabled: Option<bool>,
64    /// These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.
65    #[serde(
66        rename = "transportConfigurations",
67        skip_serializing_if = "Option::is_none"
68    )]
69    pub transport_configurations:
70        Option<Vec<models::CreateAssistantDtoTransportConfigurationsInner>>,
71    /// This is the plan for observability of assistant's calls.  Currently, only Langfuse is supported.
72    #[serde(rename = "observabilityPlan", skip_serializing_if = "Option::is_none")]
73    pub observability_plan: Option<models::LangfuseObservabilityPlan>,
74    /// These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.
75    #[serde(rename = "credentials", skip_serializing_if = "Option::is_none")]
76    pub credentials: Option<Vec<models::WorkflowUserEditableCredentialsInner>>,
77    /// This is a set of actions that will be performed on certain events.
78    #[serde(rename = "hooks", skip_serializing_if = "Option::is_none")]
79    pub hooks: Option<Vec<models::CreateAssistantDtoHooksInner>>,
80    /// These are values that will be used to replace the template variables in the assistant messages and other text-based fields. This uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html  So for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`. `{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.  Some VAPI reserved defaults:  - *customer* - the customer object
81    #[serde(rename = "variableValues", skip_serializing_if = "Option::is_none")]
82    pub variable_values: Option<serde_json::Value>,
83    /// This is the name of the assistant.  This is required when you want to transfer between assistants in a call.
84    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
85    pub name: Option<String>,
86    /// This is the message that the assistant will say if the call is forwarded to voicemail.  If unspecified, it will hang up.
87    #[serde(rename = "voicemailMessage", skip_serializing_if = "Option::is_none")]
88    pub voicemail_message: Option<String>,
89    /// This is the message that the assistant will say if it ends the call.  If unspecified, it will hang up without saying anything.
90    #[serde(rename = "endCallMessage", skip_serializing_if = "Option::is_none")]
91    pub end_call_message: Option<String>,
92    /// This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
93    #[serde(rename = "endCallPhrases", skip_serializing_if = "Option::is_none")]
94    pub end_call_phrases: Option<Vec<String>>,
95    #[serde(rename = "compliancePlan", skip_serializing_if = "Option::is_none")]
96    pub compliance_plan: Option<models::CompliancePlan>,
97    /// This is for metadata you want to store on the assistant.
98    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
99    pub metadata: Option<serde_json::Value>,
100    /// This enables filtering of noise and background speech while the user is talking.  Features: - Smart denoising using Krisp - Fourier denoising  Smart denoising can be combined with or used independently of Fourier denoising.  Order of precedence: - Smart denoising - Fourier denoising
101    #[serde(
102        rename = "backgroundSpeechDenoisingPlan",
103        skip_serializing_if = "Option::is_none"
104    )]
105    pub background_speech_denoising_plan: Option<models::BackgroundSpeechDenoisingPlan>,
106    /// This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
107    #[serde(rename = "analysisPlan", skip_serializing_if = "Option::is_none")]
108    pub analysis_plan: Option<models::AnalysisPlan>,
109    /// This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.
110    #[serde(rename = "artifactPlan", skip_serializing_if = "Option::is_none")]
111    pub artifact_plan: Option<models::ArtifactPlan>,
112    /// This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.  Note: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.
113    #[serde(rename = "messagePlan", skip_serializing_if = "Option::is_none")]
114    pub message_plan: Option<models::MessagePlan>,
115    /// This is the plan for when the assistant should start talking.  You should configure this if you're running into these issues: - The assistant is too slow to start talking after the customer is done speaking. - The assistant is too fast to start talking after the customer is done speaking. - The assistant is so fast that it's actually interrupting the customer.
116    #[serde(rename = "startSpeakingPlan", skip_serializing_if = "Option::is_none")]
117    pub start_speaking_plan: Option<models::StartSpeakingPlan>,
118    /// This is the plan for when assistant should stop talking on customer interruption.  You should configure this if you're running into these issues: - The assistant is too slow to recognize customer's interruption. - The assistant is too fast to recognize customer's interruption. - The assistant is getting interrupted by phrases that are just acknowledgments. - The assistant is getting interrupted by background noises. - The assistant is not properly stopping -- it starts talking right after getting interrupted.
119    #[serde(rename = "stopSpeakingPlan", skip_serializing_if = "Option::is_none")]
120    pub stop_speaking_plan: Option<models::StopSpeakingPlan>,
121    /// This is the plan for real-time monitoring of the assistant's calls.  Usage: - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`. - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.
122    #[serde(rename = "monitorPlan", skip_serializing_if = "Option::is_none")]
123    pub monitor_plan: Option<models::MonitorPlan>,
124    /// These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.
125    #[serde(rename = "credentialIds", skip_serializing_if = "Option::is_none")]
126    pub credential_ids: Option<Vec<String>>,
127    /// This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.  The order of precedence is:  1. assistant.server.url 2. phoneNumber.serverUrl 3. org.serverUrl
128    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
129    pub server: Option<models::Server>,
130    #[serde(rename = "keypadInputPlan", skip_serializing_if = "Option::is_none")]
131    pub keypad_input_plan: Option<models::KeypadInputPlan>,
132}
133
134impl AssistantOverrides {
135    pub fn new() -> AssistantOverrides {
136        AssistantOverrides {
137            transcriber: None,
138            model: None,
139            voice: None,
140            first_message: None,
141            first_message_interruptions_enabled: None,
142            first_message_mode: None,
143            voicemail_detection: None,
144            client_messages: None,
145            server_messages: None,
146            silence_timeout_seconds: None,
147            max_duration_seconds: None,
148            background_sound: None,
149            background_denoising_enabled: None,
150            model_output_in_messages_enabled: None,
151            transport_configurations: None,
152            observability_plan: None,
153            credentials: None,
154            hooks: None,
155            variable_values: None,
156            name: None,
157            voicemail_message: None,
158            end_call_message: None,
159            end_call_phrases: None,
160            compliance_plan: None,
161            metadata: None,
162            background_speech_denoising_plan: None,
163            analysis_plan: None,
164            artifact_plan: None,
165            message_plan: None,
166            start_speaking_plan: None,
167            stop_speaking_plan: None,
168            monitor_plan: None,
169            credential_ids: None,
170            server: None,
171            keypad_input_plan: None,
172        }
173    }
174}
175/// This is the mode for the first message. Default is 'assistant-speaks-first'.  Use: - 'assistant-speaks-first' to have the assistant speak first. - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).  @default 'assistant-speaks-first'
176#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
177pub enum FirstMessageModeTrue {
178    #[serde(rename = "assistant-speaks-first")]
179    AssistantSpeaksFirst,
180    #[serde(rename = "assistant-speaks-first-with-model-generated-message")]
181    AssistantSpeaksFirstWithModelGeneratedMessage,
182    #[serde(rename = "assistant-waits-for-user")]
183    AssistantWaitsForUser,
184}
185
186impl Default for FirstMessageModeTrue {
187    fn default() -> FirstMessageModeTrue {
188        Self::AssistantSpeaksFirst
189    }
190}
191/// These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.
192#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
193pub enum ClientMessagesTrue {
194    #[serde(rename = "conversation-update")]
195    ConversationUpdate,
196    #[serde(rename = "function-call")]
197    FunctionCall,
198    #[serde(rename = "function-call-result")]
199    FunctionCallResult,
200    #[serde(rename = "hang")]
201    Hang,
202    #[serde(rename = "language-changed")]
203    LanguageChanged,
204    #[serde(rename = "metadata")]
205    Metadata,
206    #[serde(rename = "model-output")]
207    ModelOutput,
208    #[serde(rename = "speech-update")]
209    SpeechUpdate,
210    #[serde(rename = "status-update")]
211    StatusUpdate,
212    #[serde(rename = "transcript")]
213    Transcript,
214    #[serde(rename = "tool-calls")]
215    ToolCalls,
216    #[serde(rename = "tool-calls-result")]
217    ToolCallsResult,
218    #[serde(rename = "tool.completed")]
219    ToolPeriodCompleted,
220    #[serde(rename = "transfer-update")]
221    TransferUpdate,
222    #[serde(rename = "user-interrupted")]
223    UserInterrupted,
224    #[serde(rename = "voice-input")]
225    VoiceInput,
226    #[serde(rename = "workflow.node.started")]
227    WorkflowPeriodNodePeriodStarted,
228}
229
230impl Default for ClientMessagesTrue {
231    fn default() -> ClientMessagesTrue {
232        Self::ConversationUpdate
233    }
234}
235/// These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.
236#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
237pub enum ServerMessagesTrue {
238    #[serde(rename = "conversation-update")]
239    ConversationUpdate,
240    #[serde(rename = "end-of-call-report")]
241    EndOfCallReport,
242    #[serde(rename = "function-call")]
243    FunctionCall,
244    #[serde(rename = "hang")]
245    Hang,
246    #[serde(rename = "language-changed")]
247    LanguageChanged,
248    #[serde(rename = "language-change-detected")]
249    LanguageChangeDetected,
250    #[serde(rename = "model-output")]
251    ModelOutput,
252    #[serde(rename = "phone-call-control")]
253    PhoneCallControl,
254    #[serde(rename = "speech-update")]
255    SpeechUpdate,
256    #[serde(rename = "status-update")]
257    StatusUpdate,
258    #[serde(rename = "transcript")]
259    Transcript,
260    #[serde(rename = "transcript[transcriptType=\"final\"]")]
261    TranscriptLeftSquareBracketTranscriptTypeEqualDoubleQuoteFinalDoubleQuoteRightSquareBracket,
262    #[serde(rename = "tool-calls")]
263    ToolCalls,
264    #[serde(rename = "transfer-destination-request")]
265    TransferDestinationRequest,
266    #[serde(rename = "transfer-update")]
267    TransferUpdate,
268    #[serde(rename = "user-interrupted")]
269    UserInterrupted,
270    #[serde(rename = "voice-input")]
271    VoiceInput,
272}
273
274impl Default for ServerMessagesTrue {
275    fn default() -> ServerMessagesTrue {
276        Self::ConversationUpdate
277    }
278}
vapi_client/models/assistant_overrides.rs

vapi_client/models/
assistant_overrides.rs
