vapi_client/models/
custom_knowledge_base.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::ToSchema;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
18pub struct CustomKnowledgeBase {
19    /// This knowledge base is bring your own knowledge base implementation.
20    #[serde(rename = "provider")]
21    pub provider: Provider,
22    /// 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 } ```
23    #[serde(rename = "server")]
24    pub server: models::Server,
25    /// This is the id of the knowledge base.
26    #[serde(rename = "id")]
27    pub id: String,
28    /// This is the org id of the knowledge base.
29    #[serde(rename = "orgId")]
30    pub org_id: String,
31}
32
33impl CustomKnowledgeBase {
34    pub fn new(
35        provider: Provider,
36        server: models::Server,
37        id: String,
38        org_id: String,
39    ) -> CustomKnowledgeBase {
40        CustomKnowledgeBase {
41            provider,
42            server,
43            id,
44            org_id,
45        }
46    }
47}
48/// This knowledge base is bring your own knowledge base implementation.
49#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, ToSchema)]
50pub enum Provider {
51    #[serde(rename = "custom-knowledge-base")]
52    CustomKnowledgeBase,
53}
54
55impl Default for Provider {
56    fn default() -> Provider {
57        Self::CustomKnowledgeBase
58    }
59}
vapi_client/models/custom_knowledge_base.rs

vapi_client/models/
custom_knowledge_base.rs
