vapi_client/models/
create_tool_call_block_dto.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::ToSchema;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
18pub struct CreateToolCallBlockDto {
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 id of the tool that the block will call. To use a transient tool, use `tool`.
34    #[serde(rename = "toolId", skip_serializing_if = "Option::is_none")]
35    pub tool_id: Option<String>,
36    /// This is the name of the block. This is just for your reference.
37    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
38    pub name: Option<String>,
39}
40
41impl CreateToolCallBlockDto {
42    pub fn new(r#type: Type) -> CreateToolCallBlockDto {
43        CreateToolCallBlockDto {
44            messages: None,
45            input_schema: None,
46            output_schema: None,
47            r#type,
48            tool: None,
49            tool_id: None,
50            name: None,
51        }
52    }
53}
54/// This block makes a tool call.
55#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, ToSchema)]
56pub enum Type {
57    #[serde(rename = "tool-call")]
58    ToolCall,
59}
60
61impl Default for Type {
62    fn default() -> Type {
63        Self::ToolCall
64    }
65}
vapi_client/models/create_tool_call_block_dto.rs

vapi_client/models/
create_tool_call_block_dto.rs
