vapi_client/models/
update_assistant_dto.rs

1/*
2 * Vapi API
3 *
4 * API for building voice assistants
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use serde::{Deserialize, Serialize};
12
13use crate::models;
14
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct UpdateAssistantDto {
17    #[serde(rename = "transcriber", skip_serializing_if = "Option::is_none")]
18    pub transcriber: Option<models::CreateAssistantDtoTranscriber>,
19    #[serde(rename = "model", skip_serializing_if = "Option::is_none")]
20    pub model: Option<models::CreateAssistantDtoModel>,
21    #[serde(rename = "voice", skip_serializing_if = "Option::is_none")]
22    pub voice: Option<models::CreateAssistantDtoVoice>,
23    /// 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.
24    #[serde(rename = "firstMessage", skip_serializing_if = "Option::is_none")]
25    pub first_message: Option<String>,
26    /// 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'
27    #[serde(rename = "firstMessageMode", skip_serializing_if = "Option::is_none")]
28    pub first_message_mode: Option<FirstMessageMode>,
29    /// These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. This uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached. You can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.
30    #[serde(rename = "voicemailDetection", skip_serializing_if = "Option::is_none")]
31    pub voicemail_detection: Option<serde_json::Value>,
32    /// 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. You can check the shape of the messages in ClientMessage schema.
33    #[serde(rename = "clientMessages", skip_serializing_if = "Option::is_none")]
34    pub client_messages: Option<Vec<ClientMessages>>,
35    /// 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.
36    #[serde(rename = "serverMessages", skip_serializing_if = "Option::is_none")]
37    pub server_messages: Option<Vec<ServerMessages>>,
38    /// How many seconds of silence to wait before ending the call. Defaults to 30.  @default 30
39    #[serde(
40        rename = "silenceTimeoutSeconds",
41        skip_serializing_if = "Option::is_none"
42    )]
43    pub silence_timeout_seconds: Option<f64>,
44    /// 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)
45    #[serde(rename = "maxDurationSeconds", skip_serializing_if = "Option::is_none")]
46    pub max_duration_seconds: Option<f64>,
47    /// This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
48    #[serde(rename = "backgroundSound", skip_serializing_if = "Option::is_none")]
49    pub background_sound: Option<BackgroundSound>,
50    /// This enables filtering of noise and background speech while the user is talking.  Default `false` while in beta.  @default false
51    #[serde(
52        rename = "backgroundDenoisingEnabled",
53        skip_serializing_if = "Option::is_none"
54    )]
55    pub background_denoising_enabled: Option<bool>,
56    /// 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
57    #[serde(
58        rename = "modelOutputInMessagesEnabled",
59        skip_serializing_if = "Option::is_none"
60    )]
61    pub model_output_in_messages_enabled: Option<bool>,
62    /// 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.
63    #[serde(
64        rename = "transportConfigurations",
65        skip_serializing_if = "Option::is_none"
66    )]
67    pub transport_configurations:
68        Option<Vec<models::CreateAssistantDtoTransportConfigurationsInner>>,
69    /// 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.
70    #[serde(rename = "credentials", skip_serializing_if = "Option::is_none")]
71    pub credentials: Option<Vec<models::CreateAssistantDtoCredentialsInner>>,
72    /// This is the name of the assistant.  This is required when you want to transfer between assistants in a call.
73    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
74    pub name: Option<String>,
75    /// This is the message that the assistant will say if the call is forwarded to voicemail.  If unspecified, it will hang up.
76    #[serde(rename = "voicemailMessage", skip_serializing_if = "Option::is_none")]
77    pub voicemail_message: Option<String>,
78    /// This is the message that the assistant will say if it ends the call.  If unspecified, it will hang up without saying anything.
79    #[serde(rename = "endCallMessage", skip_serializing_if = "Option::is_none")]
80    pub end_call_message: Option<String>,
81    /// This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
82    #[serde(rename = "endCallPhrases", skip_serializing_if = "Option::is_none")]
83    pub end_call_phrases: Option<Vec<String>>,
84    #[serde(rename = "compliancePlan", skip_serializing_if = "Option::is_none")]
85    pub compliance_plan: Option<models::CompliancePlan>,
86    /// This is for metadata you want to store on the assistant.
87    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
88    pub metadata: Option<serde_json::Value>,
89    /// This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
90    #[serde(rename = "analysisPlan", skip_serializing_if = "Option::is_none")]
91    pub analysis_plan: Option<models::AnalysisPlan>,
92    /// This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.  Note: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.
93    #[serde(rename = "artifactPlan", skip_serializing_if = "Option::is_none")]
94    pub artifact_plan: Option<models::ArtifactPlan>,
95    /// 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.
96    #[serde(rename = "messagePlan", skip_serializing_if = "Option::is_none")]
97    pub message_plan: Option<models::MessagePlan>,
98    /// 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.
99    #[serde(rename = "startSpeakingPlan", skip_serializing_if = "Option::is_none")]
100    pub start_speaking_plan: Option<models::StartSpeakingPlan>,
101    /// 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.
102    #[serde(rename = "stopSpeakingPlan", skip_serializing_if = "Option::is_none")]
103    pub stop_speaking_plan: Option<models::StopSpeakingPlan>,
104    /// 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`.  Note, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are currently at the root level but will be moved to `monitorPlan` in the future. Will remain backwards compatible
105    #[serde(rename = "monitorPlan", skip_serializing_if = "Option::is_none")]
106    pub monitor_plan: Option<models::MonitorPlan>,
107    /// 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.
108    #[serde(rename = "credentialIds", skip_serializing_if = "Option::is_none")]
109    pub credential_ids: Option<Vec<String>>,
110    /// 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
111    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
112    pub server: Option<models::Server>,
113    /// This is a set of actions that will be performed on certain events.
114    #[serde(rename = "hooks", skip_serializing_if = "Option::is_none")]
115    pub hooks: Option<Vec<models::AssistantHooks>>,
116    #[serde(rename = "keypadInputPlan", skip_serializing_if = "Option::is_none")]
117    pub keypad_input_plan: Option<models::KeypadInputPlan>,
118}
119
120impl UpdateAssistantDto {
121    pub fn new() -> UpdateAssistantDto {
122        UpdateAssistantDto {
123            transcriber: None,
124            model: None,
125            voice: None,
126            first_message: None,
127            first_message_mode: None,
128            voicemail_detection: None,
129            client_messages: None,
130            server_messages: None,
131            silence_timeout_seconds: None,
132            max_duration_seconds: None,
133            background_sound: None,
134            background_denoising_enabled: None,
135            model_output_in_messages_enabled: None,
136            transport_configurations: None,
137            credentials: None,
138            name: None,
139            voicemail_message: None,
140            end_call_message: None,
141            end_call_phrases: None,
142            compliance_plan: None,
143            metadata: None,
144            analysis_plan: None,
145            artifact_plan: None,
146            message_plan: None,
147            start_speaking_plan: None,
148            stop_speaking_plan: None,
149            monitor_plan: None,
150            credential_ids: None,
151            server: None,
152            hooks: None,
153            keypad_input_plan: None,
154        }
155    }
156}
157/// 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'
158#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
159pub enum FirstMessageMode {
160    #[serde(rename = "assistant-speaks-first")]
161    AssistantSpeaksFirst,
162    #[serde(rename = "assistant-speaks-first-with-model-generated-message")]
163    AssistantSpeaksFirstWithModelGeneratedMessage,
164    #[serde(rename = "assistant-waits-for-user")]
165    AssistantWaitsForUser,
166}
167
168impl Default for FirstMessageMode {
169    fn default() -> FirstMessageMode {
170        Self::AssistantSpeaksFirst
171    }
172}
173/// 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. You can check the shape of the messages in ClientMessage schema.
174#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
175pub enum ClientMessages {
176    #[serde(rename = "conversation-update")]
177    ConversationUpdate,
178    #[serde(rename = "function-call")]
179    FunctionCall,
180    #[serde(rename = "function-call-result")]
181    FunctionCallResult,
182    #[serde(rename = "hang")]
183    Hang,
184    #[serde(rename = "language-changed")]
185    LanguageChanged,
186    #[serde(rename = "metadata")]
187    Metadata,
188    #[serde(rename = "model-output")]
189    ModelOutput,
190    #[serde(rename = "speech-update")]
191    SpeechUpdate,
192    #[serde(rename = "status-update")]
193    StatusUpdate,
194    #[serde(rename = "transcript")]
195    Transcript,
196    #[serde(rename = "tool-calls")]
197    ToolCalls,
198    #[serde(rename = "tool-calls-result")]
199    ToolCallsResult,
200    #[serde(rename = "transfer-update")]
201    TransferUpdate,
202    #[serde(rename = "user-interrupted")]
203    UserInterrupted,
204    #[serde(rename = "voice-input")]
205    VoiceInput,
206}
207
208impl Default for ClientMessages {
209    fn default() -> ClientMessages {
210        Self::ConversationUpdate
211    }
212}
213/// 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.
214#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
215pub enum ServerMessages {
216    #[serde(rename = "conversation-update")]
217    ConversationUpdate,
218    #[serde(rename = "end-of-call-report")]
219    EndOfCallReport,
220    #[serde(rename = "function-call")]
221    FunctionCall,
222    #[serde(rename = "hang")]
223    Hang,
224    #[serde(rename = "language-changed")]
225    LanguageChanged,
226    #[serde(rename = "language-change-detected")]
227    LanguageChangeDetected,
228    #[serde(rename = "model-output")]
229    ModelOutput,
230    #[serde(rename = "phone-call-control")]
231    PhoneCallControl,
232    #[serde(rename = "speech-update")]
233    SpeechUpdate,
234    #[serde(rename = "status-update")]
235    StatusUpdate,
236    #[serde(rename = "transcript")]
237    Transcript,
238    #[serde(rename = "transcript[transcriptType=\"final\"]")]
239    TranscriptLeftSquareBracketTranscriptTypeEqualDoubleQuoteFinalDoubleQuoteRightSquareBracket,
240    #[serde(rename = "tool-calls")]
241    ToolCalls,
242    #[serde(rename = "transfer-destination-request")]
243    TransferDestinationRequest,
244    #[serde(rename = "transfer-update")]
245    TransferUpdate,
246    #[serde(rename = "user-interrupted")]
247    UserInterrupted,
248    #[serde(rename = "voice-input")]
249    VoiceInput,
250}
251
252impl Default for ServerMessages {
253    fn default() -> ServerMessages {
254        Self::ConversationUpdate
255    }
256}
257/// This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
258#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
259pub enum BackgroundSound {
260    #[serde(rename = "off")]
261    Off,
262    #[serde(rename = "office")]
263    Office,
264}
265
266impl Default for BackgroundSound {
267    fn default() -> BackgroundSound {
268        Self::Off
269    }
270}
vapi_client/models/update_assistant_dto.rs

vapi_client/models/
update_assistant_dto.rs
