vapi_client/models/
computer_tool_with_tool_call.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 ComputerToolWithToolCall {
16    /// These are the messages that will be spoken to the user as the tool is running.  For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
17    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
18    pub messages: Option<Vec<models::CreateDtmfToolDtoMessagesInner>>,
19    /// The type of tool. \"computer\" for Computer tool.
20    #[serde(rename = "type")]
21    pub r#type: TypeTrue,
22    /// The sub type of tool.
23    #[serde(rename = "subType")]
24    pub sub_type: SubTypeTrue,
25    ///    This is the server where a `tool-calls` webhook will be sent.    Notes:   - Webhook is sent to this server when a tool call is made.   - Webhook contains the call, assistant, and phone number objects.   - Webhook contains the variables set on the assistant.   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.   - Webhook expects a response with tool call result.
26    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
27    pub server: Option<models::Server>,
28    #[serde(rename = "toolCall")]
29    pub tool_call: models::ToolCall,
30    /// The name of the tool, fixed to 'computer'
31    #[serde(rename = "name")]
32    pub name: NameTrue,
33    /// The display width in pixels
34    #[serde(rename = "displayWidthPx")]
35    pub display_width_px: f64,
36    /// The display height in pixels
37    #[serde(rename = "displayHeightPx")]
38    pub display_height_px: f64,
39    /// Optional display number
40    #[serde(rename = "displayNumber", skip_serializing_if = "Option::is_none")]
41    pub display_number: Option<f64>,
42    /// This is the function definition of the tool.  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.  An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.
43    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
44    pub function: Option<models::OpenAiFunction>,
45}
46
47impl ComputerToolWithToolCall {
48    pub fn new(
49        r#type: TypeTrue,
50        sub_type: SubTypeTrue,
51        tool_call: models::ToolCall,
52        name: NameTrue,
53        display_width_px: f64,
54        display_height_px: f64,
55    ) -> ComputerToolWithToolCall {
56        ComputerToolWithToolCall {
57            messages: None,
58            r#type,
59            sub_type,
60            server: None,
61            tool_call,
62            name,
63            display_width_px,
64            display_height_px,
65            display_number: None,
66            function: None,
67        }
68    }
69}
70/// The type of tool. \"computer\" for Computer tool.
71#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
72pub enum TypeTrue {
73    #[serde(rename = "computer")]
74    Computer,
75}
76
77impl Default for TypeTrue {
78    fn default() -> TypeTrue {
79        Self::Computer
80    }
81}
82/// The sub type of tool.
83#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
84pub enum SubTypeTrue {
85    #[serde(rename = "computer_20241022")]
86    Computer20241022,
87}
88
89impl Default for SubTypeTrue {
90    fn default() -> SubTypeTrue {
91        Self::Computer20241022
92    }
93}
94/// The name of the tool, fixed to 'computer'
95#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
96pub enum NameTrue {
97    #[serde(rename = "computer")]
98    Computer,
99}
100
101impl Default for NameTrue {
102    fn default() -> NameTrue {
103        Self::Computer
104    }
105}
vapi_client/models/computer_tool_with_tool_call.rs

vapi_client/models/
computer_tool_with_tool_call.rs
