vapi_client/models/
text_editor_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 TextEditorToolWithToolCall {
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. \"textEditor\" for Text Editor 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 'str_replace_editor'
31    #[serde(rename = "name")]
32    pub name: NameTrue,
33    /// 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.
34    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
35    pub function: Option<models::OpenAiFunction>,
36}
37
38impl TextEditorToolWithToolCall {
39    pub fn new(
40        r#type: TypeTrue,
41        sub_type: SubTypeTrue,
42        tool_call: models::ToolCall,
43        name: NameTrue,
44    ) -> TextEditorToolWithToolCall {
45        TextEditorToolWithToolCall {
46            messages: None,
47            r#type,
48            sub_type,
49            server: None,
50            tool_call,
51            name,
52            function: None,
53        }
54    }
55}
56/// The type of tool. \"textEditor\" for Text Editor tool.
57#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
58pub enum TypeTrue {
59    #[serde(rename = "textEditor")]
60    TextEditor,
61}
62
63impl Default for TypeTrue {
64    fn default() -> TypeTrue {
65        Self::TextEditor
66    }
67}
68/// The sub type of tool.
69#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
70pub enum SubTypeTrue {
71    #[serde(rename = "text_editor_20241022")]
72    TextEditor20241022,
73}
74
75impl Default for SubTypeTrue {
76    fn default() -> SubTypeTrue {
77        Self::TextEditor20241022
78    }
79}
80/// The name of the tool, fixed to 'str_replace_editor'
81#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
82pub enum NameTrue {
83    #[serde(rename = "str_replace_editor")]
84    StrReplaceEditor,
85}
86
87impl Default for NameTrue {
88    fn default() -> NameTrue {
89        Self::StrReplaceEditor
90    }
91}
vapi_client/models/text_editor_tool_with_tool_call.rs

vapi_client/models/
text_editor_tool_with_tool_call.rs
