hirn-engine 0.1.0

Engine for the hirn cognitive memory database
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

//! Memory candidate — the input to the admission pipeline.

use hirn_core::episodic::{EntityRef, EpisodicRecord};
use hirn_core::id::MemoryId;
use hirn_core::metadata::Metadata;
use hirn_core::types::{AgentId, Namespace};

/// A candidate memory to be evaluated by the admission pipeline.
///
/// Extracted from an [`EpisodicRecord`] before it enters storage.
#[derive(Debug, Clone)]
pub struct MemoryCandidate {
    /// Unique ID for this candidate (same as the record's ID).
    pub id: MemoryId,
    /// Text content of the memory.
    pub content: String,
    /// Extracted entities.
    pub entities: Vec<EntityRef>,
    /// Pre-computed embedding vector (if available).
    pub embedding: Option<Vec<f32>>,
    /// Source agent.
    pub agent_id: AgentId,
    /// Namespace scope.
    pub namespace: Namespace,
    /// Importance score assigned by the caller.
    pub importance: f32,
    /// Surprise score assigned by the caller.
    pub surprise: f32,
    /// Arbitrary metadata.
    pub metadata: Metadata,
}

impl MemoryCandidate {
    /// Build a candidate from an [`EpisodicRecord`].
    pub fn from_record(record: &EpisodicRecord) -> Self {
        Self {
            id: record.id,
            content: record.content.clone(),
            entities: record.entities.clone(),
            embedding: record.embedding.clone(),
            agent_id: record.provenance.created_by.clone(),
            namespace: record.namespace.clone(),
            importance: record.importance,
            surprise: record.surprise,
            metadata: record.metadata.clone(),
        }
    }
}