vapi_client/models/
query_tool.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 QueryTool {
16    /// This determines if the tool is async.  If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.  If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.  Defaults to synchronous (`false`).
17    #[serde(rename = "async", skip_serializing_if = "Option::is_none")]
18    pub r#async: Option<bool>,
19    /// 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.
20    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
21    pub messages: Option<Vec<models::CreateDtmfToolDtoMessagesInner>>,
22    /// The type of tool. \"query\" for Query tool.
23    #[serde(rename = "type")]
24    pub r#type: Type,
25    /// The knowledge bases to query
26    #[serde(rename = "knowledgeBases", skip_serializing_if = "Option::is_none")]
27    pub knowledge_bases: Option<Vec<models::KnowledgeBase>>,
28    /// This is the unique identifier for the tool.
29    #[serde(rename = "id")]
30    pub id: String,
31    /// This is the unique identifier for the organization that this tool belongs to.
32    #[serde(rename = "orgId")]
33    pub org_id: String,
34    /// This is the ISO 8601 date-time string of when the tool was created.
35    #[serde(rename = "createdAt")]
36    pub created_at: String,
37    /// This is the ISO 8601 date-time string of when the tool was last updated.
38    #[serde(rename = "updatedAt")]
39    pub updated_at: String,
40    /// 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.
41    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
42    pub function: Option<Box<models::OpenAiFunction>>,
43    /// This is the server that will be hit when this tool is requested by the model.  All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.  This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
44    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
45    pub server: Option<Box<models::Server>>,
46}
47
48impl QueryTool {
49    pub fn new(r#type: Type, id: String, org_id: String, created_at: String, updated_at: String) -> QueryTool {
50        QueryTool {
51            r#async: None,
52            messages: None,
53            r#type,
54            knowledge_bases: None,
55            id,
56            org_id,
57            created_at,
58            updated_at,
59            function: None,
60            server: None,
61        }
62    }
63}
64/// The type of tool. \"query\" for Query tool.
65#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
66pub enum Type {
67    #[serde(rename = "query")]
68    Query,
69}
70
71impl Default for Type {
72    fn default() -> Type {
73        Self::Query
74    }
75}
76
vapi_client/models/query_tool.rs

vapi_client/models/
query_tool.rs
