cerebro 1.1.3

A high-performance semantic memory engine for AI Agents, now featuring SwarmForge for built-in multi-agent orchestration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use uuid::Uuid;

/// Arbitrary metadata map for storing things like author, date, source URL, etc.
pub type Metadata = HashMap<String, String>;

/// Represents a raw, unstructured piece of memory (like a full article, or a chat transcript).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Document {
    pub id: String,
    pub content: String,
    pub metadata: Metadata,
}

impl Document {
    pub fn new(content: impl Into<String>) -> Self {
        Self {
            id: Uuid::new_v4().to_string(),
            content: content.into(),
            metadata: HashMap::new(),
        }
    }

    pub fn with_metadata(mut self, k: impl Into<String>, v: impl Into<String>) -> Self {
        self.metadata.insert(k.into(), v.into());
        self
    }
}

/// A smaller segment of a Document, ready to be embedded.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Chunk {
    pub document_id: String,
    pub index: usize,
    pub text: String,
}

/// A node in the Cerebro memory graph. Contains a chunk, its vector embedding, and relationships.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Node {
    pub id: String,
    pub chunk: Chunk,
    pub embedding: Vec<f32>,
    /// IDs of related nodes to support graph traversal (e.g., previous chunk, next chunk, thematic parent).
    pub edges: Vec<String>,
}

impl Node {
    pub fn new(chunk: Chunk, embedding: Vec<f32>) -> Self {
        Self {
            id: Uuid::new_v4().to_string(),
            chunk,
            embedding,
            edges: Vec::new(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_document_new_generates_unique_ids() {
        let d1 = Document::new("hello");
        let d2 = Document::new("hello");
        assert_ne!(d1.id, d2.id);
    }

    #[test]
    fn test_document_content_stored() {
        let doc = Document::new("The Rust programming language.");
        assert_eq!(doc.content, "The Rust programming language.");
        assert!(doc.metadata.is_empty());
    }

    #[test]
    fn test_document_with_metadata_builder() {
        let doc = Document::new("test content")
            .with_metadata("author", "Suraj")
            .with_metadata("source", "test");
        assert_eq!(doc.metadata.get("author").unwrap(), "Suraj");
        assert_eq!(doc.metadata.get("source").unwrap(), "test");
        assert_eq!(doc.metadata.len(), 2);
    }

    #[test]
    fn test_document_empty_content() {
        let doc = Document::new("");
        assert_eq!(doc.content, "");
        assert!(!doc.id.is_empty());
    }

    #[test]
    fn test_node_new() {
        let chunk = Chunk { document_id: "doc-1".into(), index: 0, text: "hello world".into() };
        let embedding = vec![0.1, 0.2, 0.3];
        let node = Node::new(chunk, embedding.clone());
        assert!(!node.id.is_empty());
        assert_eq!(node.chunk.text, "hello world");
        assert_eq!(node.embedding, embedding);
        assert!(node.edges.is_empty());
    }

    #[test]
    fn test_document_serialization_roundtrip() {
        let doc = Document::new("serialize me").with_metadata("key", "val");
        let json = serde_json::to_string(&doc).unwrap();
        let deserialized: Document = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.id, doc.id);
        assert_eq!(deserialized.content, doc.content);
        assert_eq!(deserialized.metadata.get("key").unwrap(), "val");
    }

    #[test]
    fn test_node_serialization_roundtrip() {
        let chunk = Chunk { document_id: "d1".into(), index: 5, text: "chunk text".into() };
        let node = Node::new(chunk, vec![1.0, 2.0, 3.0]);
        let json = serde_json::to_string(&node).unwrap();
        let deserialized: Node = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.id, node.id);
        assert_eq!(deserialized.chunk.index, 5);
        assert_eq!(deserialized.embedding, vec![1.0, 2.0, 3.0]);
    }
}