vapi_client/models/
server_message_knowledge_base_request.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 ServerMessageKnowledgeBaseRequest {
16    #[serde(rename = "phoneNumber", skip_serializing_if = "Option::is_none")]
17    pub phone_number: Option<Box<models::ServerMessageAssistantRequestPhoneNumber>>,
18    /// This is the type of the message. \"knowledge-base-request\" is sent to request knowledge base documents. To enable, use `assistant.knowledgeBase.provider=custom-knowledge-base`.
19    #[serde(rename = "type")]
20    pub r#type: Type,
21    /// These are the messages that are going to be sent to the `model` right after the `knowledge-base-request` webhook completes.
22    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
23    pub messages: Option<Vec<models::ArtifactMessagesInner>>,
24    /// This is just `messages` formatted for OpenAI.
25    #[serde(rename = "messagesOpenAIFormatted")]
26    pub messages_open_ai_formatted: Vec<models::OpenAiMessage>,
27    /// This is the ISO-8601 formatted timestamp of when the message was sent.
28    #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")]
29    pub timestamp: Option<String>,
30    /// This is a live version of the `call.artifact`.  This matches what is stored on `call.artifact` after the call.
31    #[serde(rename = "artifact", skip_serializing_if = "Option::is_none")]
32    pub artifact: Option<Box<models::Artifact>>,
33    /// This is the assistant that is currently active. This is provided for convenience.  This matches one of the following: - `call.assistant`, - `call.assistantId`, - `call.squad[n].assistant`, - `call.squad[n].assistantId`, - `call.squadId->[n].assistant`, - `call.squadId->[n].assistantId`.
34    #[serde(rename = "assistant", skip_serializing_if = "Option::is_none")]
35    pub assistant: Option<Box<models::CreateAssistantDto>>,
36    /// This is the customer associated with the call.  This matches one of the following: - `call.customer`, - `call.customerId`.
37    #[serde(rename = "customer", skip_serializing_if = "Option::is_none")]
38    pub customer: Option<Box<models::CreateCustomerDto>>,
39    /// This is the call object.  This matches what was returned in POST /call.  Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.
40    #[serde(rename = "call", skip_serializing_if = "Option::is_none")]
41    pub call: Option<Box<models::Call>>,
42}
43
44impl ServerMessageKnowledgeBaseRequest {
45    pub fn new(r#type: Type, messages_open_ai_formatted: Vec<models::OpenAiMessage>) -> ServerMessageKnowledgeBaseRequest {
46        ServerMessageKnowledgeBaseRequest {
47            phone_number: None,
48            r#type,
49            messages: None,
50            messages_open_ai_formatted,
51            timestamp: None,
52            artifact: None,
53            assistant: None,
54            customer: None,
55            call: None,
56        }
57    }
58}
59/// This is the type of the message. \"knowledge-base-request\" is sent to request knowledge base documents. To enable, use `assistant.knowledgeBase.provider=custom-knowledge-base`.
60#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
61pub enum Type {
62    #[serde(rename = "knowledge-base-request")]
63    KnowledgeBaseRequest,
64}
65
66impl Default for Type {
67    fn default() -> Type {
68        Self::KnowledgeBaseRequest
69    }
70}
71
vapi_client/models/server_message_knowledge_base_request.rs

vapi_client/models/
server_message_knowledge_base_request.rs
