vapi_client/models/
vapi_model.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 VapiModel {
16    /// This is the starting state for the conversation.
17    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
18    pub messages: Option<Vec<models::OpenAiMessage>>,
19    /// These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.  Both `tools` and `toolIds` can be used together.
20    #[serde(rename = "tools", skip_serializing_if = "Option::is_none")]
21    pub tools: Option<Vec<models::AnyscaleModelToolsInner>>,
22    /// These are the tools that the assistant can use during the call. To use transient tools, use `tools`.  Both `tools` and `toolIds` can be used together.
23    #[serde(rename = "toolIds", skip_serializing_if = "Option::is_none")]
24    pub tool_ids: Option<Vec<String>>,
25    #[serde(rename = "knowledgeBase", skip_serializing_if = "Option::is_none")]
26    pub knowledge_base: Option<models::CreateCustomKnowledgeBaseDto>,
27    /// This is the ID of the knowledge base the model will use.
28    #[serde(rename = "knowledgeBaseId", skip_serializing_if = "Option::is_none")]
29    pub knowledge_base_id: Option<String>,
30    #[serde(rename = "provider")]
31    pub provider: ProviderTrue,
32    /// This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead.
33    #[serde(rename = "workflowId", skip_serializing_if = "Option::is_none")]
34    pub workflow_id: Option<String>,
35    /// This is the workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.
36    #[serde(rename = "workflow", skip_serializing_if = "Option::is_none")]
37    pub workflow: Option<models::WorkflowUserEditable>,
38    /// This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
39    #[serde(rename = "model")]
40    pub model: String,
41    /// This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.
42    #[serde(rename = "temperature", skip_serializing_if = "Option::is_none")]
43    pub temperature: Option<f64>,
44    /// This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.
45    #[serde(rename = "maxTokens", skip_serializing_if = "Option::is_none")]
46    pub max_tokens: Option<f64>,
47    /// This determines whether we detect user's emotion while they speak and send it as an additional info to model.  Default `false` because the model is usually are good at understanding the user's emotion from text.  @default false
48    #[serde(
49        rename = "emotionRecognitionEnabled",
50        skip_serializing_if = "Option::is_none"
51    )]
52    pub emotion_recognition_enabled: Option<bool>,
53    /// This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.  Default is 0.  @default 0
54    #[serde(rename = "numFastTurns", skip_serializing_if = "Option::is_none")]
55    pub num_fast_turns: Option<f64>,
56}
57
58impl VapiModel {
59    pub fn new(provider: ProviderTrue, model: String) -> VapiModel {
60        VapiModel {
61            messages: None,
62            tools: None,
63            tool_ids: None,
64            knowledge_base: None,
65            knowledge_base_id: None,
66            provider,
67            workflow_id: None,
68            workflow: None,
69            model,
70            temperature: None,
71            max_tokens: None,
72            emotion_recognition_enabled: None,
73            num_fast_turns: None,
74        }
75    }
76}
77///
78#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
79pub enum ProviderTrue {
80    #[serde(rename = "vapi")]
81    Vapi,
82}
83
84impl Default for ProviderTrue {
85    fn default() -> ProviderTrue {
86        Self::Vapi
87    }
88}
vapi_client/models/vapi_model.rs

vapi_client/models/
vapi_model.rs
