Struct CustomKnowledgeBase

pub struct CustomKnowledgeBase {
    pub provider: Provider,
    pub server: Server,
    pub id: String,
    pub org_id: String,
}

Fields

provider: Provider

This knowledge base is bring your own knowledge base implementation.

server: Server

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 }

id: String

This is the id of the knowledge base.

org_id: String

This is the org id of the knowledge base.

Implementations

impl CustomKnowledgeBase

pub fn new( provider: Provider, server: Server, id: String, org_id: String, ) -> CustomKnowledgeBase

Trait Implementations

impl Clone for CustomKnowledgeBase

fn clone(&self) -> CustomKnowledgeBase

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CustomKnowledgeBase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CustomKnowledgeBase

fn default() -> CustomKnowledgeBase

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomKnowledgeBase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OpenApi for CustomKnowledgeBase

fn openapi() -> OpenApi

Return the openapi::OpenApi instance which can be parsed with serde or served via OpenAPI visualization tool such as Swagger UI.

impl PartialEq for CustomKnowledgeBase

fn eq(&self, other: &CustomKnowledgeBase) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CustomKnowledgeBase

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CustomKnowledgeBase