vapi_client/models/
create_computer_tool_dto.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 CreateComputerToolDto {
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    /// The name of the tool, fixed to 'computer'
29    #[serde(rename = "name")]
30    pub name: NameTrue,
31    /// The display width in pixels
32    #[serde(rename = "displayWidthPx")]
33    pub display_width_px: f64,
34    /// The display height in pixels
35    #[serde(rename = "displayHeightPx")]
36    pub display_height_px: f64,
37    /// Optional display number
38    #[serde(rename = "displayNumber", skip_serializing_if = "Option::is_none")]
39    pub display_number: Option<f64>,
40    /// 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.
41    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
42    pub function: Option<models::OpenAiFunction>,
43}
44
45impl CreateComputerToolDto {
46    pub fn new(
47        r#type: TypeTrue,
48        sub_type: SubTypeTrue,
49        name: NameTrue,
50        display_width_px: f64,
51        display_height_px: f64,
52    ) -> CreateComputerToolDto {
53        CreateComputerToolDto {
54            messages: None,
55            r#type,
56            sub_type,
57            server: None,
58            name,
59            display_width_px,
60            display_height_px,
61            display_number: None,
62            function: None,
63        }
64    }
65}
66/// The type of tool. \"computer\" for Computer tool.
67#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
68pub enum TypeTrue {
69    #[serde(rename = "computer")]
70    Computer,
71}
72
73impl Default for TypeTrue {
74    fn default() -> TypeTrue {
75        Self::Computer
76    }
77}
78/// The sub type of tool.
79#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
80pub enum SubTypeTrue {
81    #[serde(rename = "computer_20241022")]
82    Computer20241022,
83}
84
85impl Default for SubTypeTrue {
86    fn default() -> SubTypeTrue {
87        Self::Computer20241022
88    }
89}
90/// The name of the tool, fixed to 'computer'
91#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
92pub enum NameTrue {
93    #[serde(rename = "computer")]
94    Computer,
95}
96
97impl Default for NameTrue {
98    fn default() -> NameTrue {
99        Self::Computer
100    }
101}
vapi_client/models/create_computer_tool_dto.rs

vapi_client/models/
create_computer_tool_dto.rs
