vapi_client/models/conversation_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 ConversationBlock {
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 is used for conversation. This can be a free flow conversation or a conversation with a specific goal like collecting some information. For free block conversation, put clearly in the `instruction` when the block can be considered done. ``` { \"type\": \"conversation\", \"instruction\": \"Chit chat with the user asking them about their day. When user asks a specific question or once you have talked to the user for a couple of turns of conversation, move on.\" } ``` For conversation with a specific goal, you can define an `outputSchema` with required fields. The block won't be considered done until the user has provided all the required fields in the `outputSchema`. ``` { \"type\": \"conversation\", \"instruction\": \"Ask the user about their hobbies, hopes and dreams.\", \"outputSchema\": { \"type\": \"object\", \"properties\": { \"hobbies\": { \"type\": \"string\" }, \"hopes\": { \"type\": \"string\" }, \"dreams\": { \"type\": \"string\" } }, \"required\": [\"hobbies\"] } } ``` For the above example, the conversation block will be considered done once the user has provided the `hobbies` (even if they have not provided the `hopes` and `dreams`).
29 #[serde(rename = "type")]
30 pub r#type: Type,
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 instruction to the model. You can reference any variable in the context of the current block execution (step): - \"{{input.your-property-name}}\" for the current step's input - \"{{your-step-name.output.your-property-name}}\" for another step's output (in the same workflow; read caveat #1) - \"{{your-step-name.input.your-property-name}}\" for another step's input (in the same workflow; read caveat #1) - \"{{your-block-name.output.your-property-name}}\" for another block's output (in the same workflow; read caveat #2) - \"{{your-block-name.input.your-property-name}}\" for another block's input (in the same workflow; read caveat #2) - \"{{workflow.input.your-property-name}}\" for the current workflow's input - \"{{global.your-property-name}}\" for the global context This can be as simple or as complex as you want it to be. - \"say hello and ask the user about their day!\" - \"collect the user's first and last name\" - \"user is {{input.firstName}} {{input.lastName}}. their age is {{input.age}}. ask them about their salary and if they might be interested in buying a house. we offer {{input.offer}}\" Caveats: 1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output/input.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/input.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.
47 #[serde(rename = "instruction")]
48 pub instruction: String,
49}
50
51impl ConversationBlock {
52 pub fn new(
53 r#type: Type,
54 id: String,
55 org_id: String,
56 created_at: String,
57 updated_at: String,
58 instruction: String,
59 ) -> ConversationBlock {
60 ConversationBlock {
61 messages: None,
62 input_schema: None,
63 output_schema: None,
64 r#type,
65 id,
66 org_id,
67 created_at,
68 updated_at,
69 name: None,
70 instruction,
71 }
72 }
73}
74/// This block is used for conversation. This can be a free flow conversation or a conversation with a specific goal like collecting some information. For free block conversation, put clearly in the `instruction` when the block can be considered done. ``` { \"type\": \"conversation\", \"instruction\": \"Chit chat with the user asking them about their day. When user asks a specific question or once you have talked to the user for a couple of turns of conversation, move on.\" } ``` For conversation with a specific goal, you can define an `outputSchema` with required fields. The block won't be considered done until the user has provided all the required fields in the `outputSchema`. ``` { \"type\": \"conversation\", \"instruction\": \"Ask the user about their hobbies, hopes and dreams.\", \"outputSchema\": { \"type\": \"object\", \"properties\": { \"hobbies\": { \"type\": \"string\" }, \"hopes\": { \"type\": \"string\" }, \"dreams\": { \"type\": \"string\" } }, \"required\": [\"hobbies\"] } } ``` For the above example, the conversation block will be considered done once the user has provided the `hobbies` (even if they have not provided the `hopes` and `dreams`).
75#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, OpenApi)]
76pub enum Type {
77 #[serde(rename = "conversation")]
78 Conversation,
79}
80
81impl Default for Type {
82 fn default() -> Type {
83 Self::Conversation
84 }
85}