Trait RagEntity

Source

pub trait RagEntity:
    CandidType
    + Serialize
    + Clone {
    // Required methods
    fn entity_type() -> &'static str
       where Self: Sized;
    fn entity_id(&self) -> String;
    fn to_context_map(&self) -> Vec<(String, String)>;
    fn relationships(&self) -> Vec<EntityRelationship>;

    // Provided methods
    fn to_text(&self) -> String { ... }
    fn to_summary(&self, max_length: usize) -> String { ... }
}

Expand description

Trait that marks a struct as a RAG entity

Implement this trait for your canister data structures to enable automatic context building and relationship mapping.

§Example

use contrag_core::prelude::*;
use candid::{CandidType, Deserialize};
use serde::Serialize;
 
#[derive(CandidType, Deserialize, Serialize, Clone)]
pub struct User {
    pub id: String,
    pub name: String,
    pub email: String,
}
 
impl RagEntity for User {
    fn entity_type() -> &'static str {
        "User"
    }
     
    fn entity_id(&self) -> String {
        self.id.clone()
    }
     
    fn to_context_map(&self) -> Vec<(String, String)> {
        vec![
            ("id".to_string(), self.id.clone()),
            ("name".to_string(), self.name.clone()),
            ("email".to_string(), self.email.clone()),
        ]
    }
     
    fn relationships(&self) -> Vec<EntityRelationship> {
        vec![]
    }
}