weavatrix-memory 0.3.1

Event-sourced, bitemporal context compiler for coding agents
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
127
128
129

use crate::{EntityId, MemoryView, Result, Timestamp};
use serde::{Deserialize, Serialize};
use std::collections::BTreeSet;
use weavatrix_graph::Graph;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ContextRequest {
    pub seeds: Vec<EntityId>,
    pub valid_at: Timestamp,
    pub known_at: Timestamp,
    pub token_budget: usize,
    pub max_depth: usize,
    #[serde(default)]
    pub relations: BTreeSet<String>,
    #[serde(default)]
    pub repositories: BTreeSet<String>,
    #[serde(default)]
    pub branches: BTreeSet<String>,
}

impl ContextRequest {
    /// Creates a bounded context request.
    ///
    /// # Errors
    ///
    /// Requires at least one seed and a non-zero token budget.
    pub fn new(
        seeds: Vec<EntityId>,
        valid_at: Timestamp,
        known_at: Timestamp,
        token_budget: usize,
    ) -> Result<Self> {
        if seeds.is_empty() {
            return Err(crate::MemoryError::InvalidValue {
                field: "context.seeds",
                reason: "at least one seed is required",
            });
        }
        if token_budget == 0 {
            return Err(crate::MemoryError::InvalidValue {
                field: "context.token_budget",
                reason: "must be greater than zero",
            });
        }
        Ok(Self {
            seeds,
            valid_at,
            known_at,
            token_budget,
            max_depth: 2,
            relations: BTreeSet::new(),
            repositories: BTreeSet::new(),
            branches: BTreeSet::new(),
        })
    }

    /// Creates a seedless template for `ContextCompiler::compile_with_retrieval`.
    ///
    /// # Errors
    ///
    /// Rejects a zero token budget.
    pub fn for_retrieval(
        valid_at: Timestamp,
        known_at: Timestamp,
        token_budget: usize,
    ) -> Result<Self> {
        if token_budget == 0 {
            return Err(crate::MemoryError::InvalidValue {
                field: "context.token_budget",
                reason: "must be greater than zero",
            });
        }
        Ok(Self {
            seeds: Vec::new(),
            valid_at,
            known_at,
            token_budget,
            max_depth: 2,
            relations: BTreeSet::new(),
            repositories: BTreeSet::new(),
            branches: BTreeSet::new(),
        })
    }

    #[must_use]
    pub const fn with_max_depth(mut self, max_depth: usize) -> Self {
        self.max_depth = max_depth;
        self
    }

    #[must_use]
    pub fn include_relation(mut self, relation: impl Into<String>) -> Self {
        self.relations.insert(relation.into());
        self
    }

    #[must_use]
    pub fn in_repository(mut self, repository: impl Into<String>) -> Self {
        self.repositories.insert(repository.into());
        self
    }

    #[must_use]
    pub fn on_branch(mut self, branch: impl Into<String>) -> Self {
        self.branches.insert(branch.into());
        self
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ContextReceipt {
    pub valid_at: Timestamp,
    pub known_at: Timestamp,
    pub source_position: Option<u64>,
    pub estimator: String,
    pub token_budget: usize,
    pub estimated_tokens: usize,
    pub examined_facts: usize,
    pub selected_facts: usize,
    pub omitted_by_budget: usize,
    pub excluded_by_scope: usize,
}

#[derive(Debug, Clone)]
pub struct ContextBundle {
    pub view: MemoryView,
    pub graph: Graph,
    pub receipt: ContextReceipt,
}