vapi_client/models/
create_query_tool_dto.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 CreateQueryToolDto {
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. \"query\" for Query tool.
20    #[serde(rename = "type")]
21    pub r#type: TypeTrue,
22    /// The knowledge bases to query
23    #[serde(rename = "knowledgeBases", skip_serializing_if = "Option::is_none")]
24    pub knowledge_bases: Option<Vec<models::KnowledgeBase>>,
25    /// 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.
26    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
27    pub function: Option<models::OpenAiFunction>,
28}
29
30impl CreateQueryToolDto {
31    pub fn new(r#type: TypeTrue) -> CreateQueryToolDto {
32        CreateQueryToolDto {
33            messages: None,
34            r#type,
35            knowledge_bases: None,
36            function: None,
37        }
38    }
39}
40/// The type of tool. \"query\" for Query tool.
41#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
42pub enum TypeTrue {
43    #[serde(rename = "query")]
44    Query,
45}
46
47impl Default for TypeTrue {
48    fn default() -> TypeTrue {
49        Self::Query
50    }
51}
vapi_client/models/create_query_tool_dto.rs

vapi_client/models/
create_query_tool_dto.rs
