vapi_client/models/
tool_call_block.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::OpenApi;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, OpenApi)]
18pub struct ToolCallBlock {
19    /// These are the pre-configured messages that will be spoken to the user while the block is running.
20    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
21    pub messages: Option<Vec<models::ConversationBlockMessagesInner>>,
22    /// This is the input schema for the block. This is the input the block needs to run. It's given to the block as `steps[0].input`  These are accessible as variables: - ({{input.propertyName}}) in context of the block execution (step) - ({{stepName.input.propertyName}}) in context of the workflow
23    #[serde(rename = "inputSchema", skip_serializing_if = "Option::is_none")]
24    pub input_schema: Option<models::JsonSchema>,
25    /// This is the output schema for the block. This is the output the block will return to the workflow (`{{stepName.output}}`).  These are accessible as variables: - ({{output.propertyName}}) in context of the block execution (step) - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1) - ({{blockName.output.propertyName}}) in context of the workflow (read caveat #2)  Caveats: 1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output.propertyName}} will reference the latest usage of the step. 2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow with steps.
26    #[serde(rename = "outputSchema", skip_serializing_if = "Option::is_none")]
27    pub output_schema: Option<models::JsonSchema>,
28    /// This block makes a tool call.
29    #[serde(rename = "type")]
30    pub r#type: Type,
31    #[serde(rename = "tool", skip_serializing_if = "Option::is_none")]
32    pub tool: Option<models::ToolCallBlockTool>,
33    /// This is the unique identifier for the block.
34    #[serde(rename = "id")]
35    pub id: String,
36    /// This is the unique identifier for the organization that this block belongs to.
37    #[serde(rename = "orgId")]
38    pub org_id: String,
39    /// This is the ISO 8601 date-time string of when the block was created.
40    #[serde(rename = "createdAt")]
41    pub created_at: String,
42    /// This is the ISO 8601 date-time string of when the block was last updated.
43    #[serde(rename = "updatedAt")]
44    pub updated_at: String,
45    /// This is the name of the block. This is just for your reference.
46    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
47    pub name: Option<String>,
48    /// This is the id of the tool that the block will call. To use a transient tool, use `tool`.
49    #[serde(rename = "toolId", skip_serializing_if = "Option::is_none")]
50    pub tool_id: Option<String>,
51}
52
53impl ToolCallBlock {
54    pub fn new(
55        r#type: Type,
56        id: String,
57        org_id: String,
58        created_at: String,
59        updated_at: String,
60    ) -> ToolCallBlock {
61        ToolCallBlock {
62            messages: None,
63            input_schema: None,
64            output_schema: None,
65            r#type,
66            tool: None,
67            id,
68            org_id,
69            created_at,
70            updated_at,
71            name: None,
72            tool_id: None,
73        }
74    }
75}
76/// This block makes a tool call.
77#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, OpenApi)]
78pub enum Type {
79    #[serde(rename = "tool-call")]
80    ToolCall,
81}
82
83impl Default for Type {
84    fn default() -> Type {
85        Self::ToolCall
86    }
87}
vapi_client/models/tool_call_block.rs

vapi_client/models/
tool_call_block.rs
