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};
12
13use crate::models;
14
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct ToolCallBlock {
17    /// These are the pre-configured messages that will be spoken to the user while the block is running.
18    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
19    pub messages: Option<Vec<models::ConversationBlockMessagesInner>>,
20    /// 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
21    #[serde(rename = "inputSchema", skip_serializing_if = "Option::is_none")]
22    pub input_schema: Option<models::JsonSchema>,
23    /// 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.
24    #[serde(rename = "outputSchema", skip_serializing_if = "Option::is_none")]
25    pub output_schema: Option<models::JsonSchema>,
26    /// This block makes a tool call.
27    #[serde(rename = "type")]
28    pub r#type: Type,
29    #[serde(rename = "tool", skip_serializing_if = "Option::is_none")]
30    pub tool: Option<models::ToolCallBlockTool>,
31    /// This is the unique identifier for the block.
32    #[serde(rename = "id")]
33    pub id: String,
34    /// This is the unique identifier for the organization that this block belongs to.
35    #[serde(rename = "orgId")]
36    pub org_id: String,
37    /// This is the ISO 8601 date-time string of when the block was created.
38    #[serde(rename = "createdAt")]
39    pub created_at: String,
40    /// This is the ISO 8601 date-time string of when the block was last updated.
41    #[serde(rename = "updatedAt")]
42    pub updated_at: String,
43    /// This is the name of the block. This is just for your reference.
44    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
45    pub name: Option<String>,
46    /// This is the id of the tool that the block will call. To use a transient tool, use `tool`.
47    #[serde(rename = "toolId", skip_serializing_if = "Option::is_none")]
48    pub tool_id: Option<String>,
49}
50
51impl ToolCallBlock {
52    pub fn new(
53        r#type: Type,
54        id: String,
55        org_id: String,
56        created_at: String,
57        updated_at: String,
58    ) -> ToolCallBlock {
59        ToolCallBlock {
60            messages: None,
61            input_schema: None,
62            output_schema: None,
63            r#type,
64            tool: None,
65            id,
66            org_id,
67            created_at,
68            updated_at,
69            name: None,
70            tool_id: None,
71        }
72    }
73}
74/// This block makes a tool call.
75#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
76pub enum Type {
77    #[serde(rename = "tool-call")]
78    ToolCall,
79}
80
81impl Default for Type {
82    fn default() -> Type {
83        Self::ToolCall
84    }
85}
vapi_client/models/tool_call_block.rs

vapi_client/models/
tool_call_block.rs
