vapi_client/models/
custom_knowledge_base.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 CustomKnowledgeBase {
16    /// This knowledge base is bring your own knowledge base implementation.
17    #[serde(rename = "provider")]
18    pub provider: Provider,
19    /// This is where the knowledge base request will be sent.  Request Example:  POST https://{server.url} Content-Type: application/json  {   \"messsage\": {     \"type\": \"knowledge-base-request\",     \"messages\": [       {         \"role\": \"user\",         \"content\": \"Why is ocean blue?\"       }     ],     ...other metadata about the call...   } }  Response Expected: ``` {   \"message\": {      \"role\": \"assistant\",      \"content\": \"The ocean is blue because water absorbs everything but blue.\",   }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK   \"documents\": [     {       \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",       \"similarity\": 1     },     {       \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",       \"similarity\": .5     }   ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL } ```
20    #[serde(rename = "server")]
21    pub server: Box<models::Server>,
22    /// This is the id of the knowledge base.
23    #[serde(rename = "id")]
24    pub id: String,
25    /// This is the org id of the knowledge base.
26    #[serde(rename = "orgId")]
27    pub org_id: String,
28}
29
30impl CustomKnowledgeBase {
31    pub fn new(provider: Provider, server: models::Server, id: String, org_id: String) -> CustomKnowledgeBase {
32        CustomKnowledgeBase {
33            provider,
34            server: Box::new(server),
35            id,
36            org_id,
37        }
38    }
39}
40/// This knowledge base is bring your own knowledge base implementation.
41#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
42pub enum Provider {
43    #[serde(rename = "custom-knowledge-base")]
44    CustomKnowledgeBase,
45}
46
47impl Default for Provider {
48    fn default() -> Provider {
49        Self::CustomKnowledgeBase
50    }
51}
52
vapi_client/models/custom_knowledge_base.rs

vapi_client/models/
custom_knowledge_base.rs
