vapi_client/models/
assistant.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};
12use utoipa::ToSchema;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
18pub struct Assistant {
19    #[serde(rename = "transcriber", skip_serializing_if = "Option::is_none")]
20    pub transcriber: Option<models::CreateAssistantDtoTranscriber>,
21    #[serde(rename = "model", skip_serializing_if = "Option::is_none")]
22    pub model: Option<models::CreateAssistantDtoModel>,
23    #[serde(rename = "voice", skip_serializing_if = "Option::is_none")]
24    pub voice: Option<models::CreateAssistantDtoVoice>,
25    /// 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.
26    #[serde(rename = "firstMessage", skip_serializing_if = "Option::is_none")]
27    pub first_message: Option<String>,
28    /// 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'
29    #[serde(rename = "firstMessageMode", skip_serializing_if = "Option::is_none")]
30    pub first_message_mode: Option<FirstMessageMode>,
31    /// 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.
32    #[serde(rename = "voicemailDetection", skip_serializing_if = "Option::is_none")]
33    pub voicemail_detection: Option<serde_json::Value>,
34    /// 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.
35    #[serde(rename = "clientMessages", skip_serializing_if = "Option::is_none")]
36    pub client_messages: Option<Vec<ClientMessages>>,
37    /// 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.
38    #[serde(rename = "serverMessages", skip_serializing_if = "Option::is_none")]
39    pub server_messages: Option<Vec<ServerMessages>>,
40    /// How many seconds of silence to wait before ending the call. Defaults to 30.  @default 30
41    #[serde(
42        rename = "silenceTimeoutSeconds",
43        skip_serializing_if = "Option::is_none"
44    )]
45    pub silence_timeout_seconds: Option<f64>,
46    /// 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)
47    #[serde(rename = "maxDurationSeconds", skip_serializing_if = "Option::is_none")]
48    pub max_duration_seconds: Option<f64>,
49    /// This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
50    #[serde(rename = "backgroundSound", skip_serializing_if = "Option::is_none")]
51    pub background_sound: Option<BackgroundSound>,
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    /// 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.
72    #[serde(rename = "credentials", skip_serializing_if = "Option::is_none")]
73    pub credentials: Option<Vec<models::CreateAssistantDtoCredentialsInner>>,
74    /// This is the name of the assistant.  This is required when you want to transfer between assistants in a call.
75    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
76    pub name: Option<String>,
77    /// This is the message that the assistant will say if the call is forwarded to voicemail.  If unspecified, it will hang up.
78    #[serde(rename = "voicemailMessage", skip_serializing_if = "Option::is_none")]
79    pub voicemail_message: Option<String>,
80    /// This is the message that the assistant will say if it ends the call.  If unspecified, it will hang up without saying anything.
81    #[serde(rename = "endCallMessage", skip_serializing_if = "Option::is_none")]
82    pub end_call_message: Option<String>,
83    /// This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
84    #[serde(rename = "endCallPhrases", skip_serializing_if = "Option::is_none")]
85    pub end_call_phrases: Option<Vec<String>>,
86    #[serde(rename = "compliancePlan", skip_serializing_if = "Option::is_none")]
87    pub compliance_plan: Option<models::CompliancePlan>,
88    /// This is for metadata you want to store on the assistant.
89    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
90    pub metadata: Option<serde_json::Value>,
91    /// This is the plan for analysis of assistant's calls. Stored in `call.analysis`.
92    #[serde(rename = "analysisPlan", skip_serializing_if = "Option::is_none")]
93    pub analysis_plan: Option<models::AnalysisPlan>,
94    /// 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.
95    #[serde(rename = "artifactPlan", skip_serializing_if = "Option::is_none")]
96    pub artifact_plan: Option<models::ArtifactPlan>,
97    /// 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.
98    #[serde(rename = "messagePlan", skip_serializing_if = "Option::is_none")]
99    pub message_plan: Option<models::MessagePlan>,
100    /// 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.
101    #[serde(rename = "startSpeakingPlan", skip_serializing_if = "Option::is_none")]
102    pub start_speaking_plan: Option<models::StartSpeakingPlan>,
103    /// 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.
104    #[serde(rename = "stopSpeakingPlan", skip_serializing_if = "Option::is_none")]
105    pub stop_speaking_plan: Option<models::StopSpeakingPlan>,
106    /// 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
107    #[serde(rename = "monitorPlan", skip_serializing_if = "Option::is_none")]
108    pub monitor_plan: Option<models::MonitorPlan>,
109    /// 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.
110    #[serde(rename = "credentialIds", skip_serializing_if = "Option::is_none")]
111    pub credential_ids: Option<Vec<String>>,
112    /// 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
113    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
114    pub server: Option<models::Server>,
115    /// This is a set of actions that will be performed on certain events.
116    #[serde(rename = "hooks", skip_serializing_if = "Option::is_none")]
117    pub hooks: Option<Vec<models::AssistantHooks>>,
118    #[serde(rename = "keypadInputPlan", skip_serializing_if = "Option::is_none")]
119    pub keypad_input_plan: Option<models::KeypadInputPlan>,
120    /// This is the unique identifier for the assistant.
121    #[serde(rename = "id")]
122    pub id: String,
123    /// This is the unique identifier for the org that this assistant belongs to.
124    #[serde(rename = "orgId")]
125    pub org_id: String,
126    /// This is the ISO 8601 date-time string of when the assistant was created.
127    #[serde(rename = "createdAt")]
128    pub created_at: String,
129    /// This is the ISO 8601 date-time string of when the assistant was last updated.
130    #[serde(rename = "updatedAt")]
131    pub updated_at: String,
132}
133
134impl Assistant {
135    pub fn new(id: String, org_id: String, created_at: String, updated_at: String) -> Assistant {
136        Assistant {
137            transcriber: None,
138            model: None,
139            voice: None,
140            first_message: None,
141            first_message_mode: None,
142            voicemail_detection: None,
143            client_messages: None,
144            server_messages: None,
145            silence_timeout_seconds: None,
146            max_duration_seconds: None,
147            background_sound: None,
148            background_denoising_enabled: None,
149            model_output_in_messages_enabled: None,
150            transport_configurations: None,
151            credentials: None,
152            name: None,
153            voicemail_message: None,
154            end_call_message: None,
155            end_call_phrases: None,
156            compliance_plan: None,
157            metadata: None,
158            analysis_plan: None,
159            artifact_plan: None,
160            message_plan: None,
161            start_speaking_plan: None,
162            stop_speaking_plan: None,
163            monitor_plan: None,
164            credential_ids: None,
165            server: None,
166            hooks: None,
167            keypad_input_plan: None,
168            id,
169            org_id,
170            created_at,
171            updated_at,
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, ToSchema)]
177pub enum FirstMessageMode {
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 FirstMessageMode {
187    fn default() -> FirstMessageMode {
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. You can check the shape of the messages in ClientMessage schema.
192#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, ToSchema)]
193pub enum ClientMessages {
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 = "transfer-update")]
219    TransferUpdate,
220    #[serde(rename = "user-interrupted")]
221    UserInterrupted,
222    #[serde(rename = "voice-input")]
223    VoiceInput,
224}
225
226impl Default for ClientMessages {
227    fn default() -> ClientMessages {
228        Self::ConversationUpdate
229    }
230}
231/// 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.
232#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, ToSchema)]
233pub enum ServerMessages {
234    #[serde(rename = "conversation-update")]
235    ConversationUpdate,
236    #[serde(rename = "end-of-call-report")]
237    EndOfCallReport,
238    #[serde(rename = "function-call")]
239    FunctionCall,
240    #[serde(rename = "hang")]
241    Hang,
242    #[serde(rename = "language-changed")]
243    LanguageChanged,
244    #[serde(rename = "language-change-detected")]
245    LanguageChangeDetected,
246    #[serde(rename = "model-output")]
247    ModelOutput,
248    #[serde(rename = "phone-call-control")]
249    PhoneCallControl,
250    #[serde(rename = "speech-update")]
251    SpeechUpdate,
252    #[serde(rename = "status-update")]
253    StatusUpdate,
254    #[serde(rename = "transcript")]
255    Transcript,
256    #[serde(rename = "transcript[transcriptType=\"final\"]")]
257    TranscriptLeftSquareBracketTranscriptTypeEqualDoubleQuoteFinalDoubleQuoteRightSquareBracket,
258    #[serde(rename = "tool-calls")]
259    ToolCalls,
260    #[serde(rename = "transfer-destination-request")]
261    TransferDestinationRequest,
262    #[serde(rename = "transfer-update")]
263    TransferUpdate,
264    #[serde(rename = "user-interrupted")]
265    UserInterrupted,
266    #[serde(rename = "voice-input")]
267    VoiceInput,
268}
269
270impl Default for ServerMessages {
271    fn default() -> ServerMessages {
272        Self::ConversationUpdate
273    }
274}
275/// This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
276#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, ToSchema)]
277pub enum BackgroundSound {
278    #[serde(rename = "off")]
279    Off,
280    #[serde(rename = "office")]
281    Office,
282}
283
284impl Default for BackgroundSound {
285    fn default() -> BackgroundSound {
286        Self::Off
287    }
288}
vapi_client/models/assistant.rs

vapi_client/models/
assistant.rs
