basemyai 0.1.0

Local memory engine for AI agents: 4 memory layers, temporal RAG, per-agent isolation, mandatory encryption. Built on basemyai-core.
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
//! Façade mémoire. Injecte les primitives du core (`Store`, `VectorIndex`,
//! `Embedder`) — testable en isolation via des doubles. Applique l'isolation
//! par agent et le RAG temporel par-dessus.

mod event;
mod isolation;
mod layer;
mod porting;
pub(crate) mod schema;
#[cfg(feature = "test-util")]
mod testutil;

pub use event::{MemoryEvent, MemoryEventKind, MemorySubscription};
pub use isolation::AgentId;
pub use layer::{AgentStats, MemoryLayer, Record};
pub use porting::ImportReport;
#[cfg(feature = "test-util")]
pub use testutil::HashEmbedder;

use basemyai_core::{Embedder, Metric, Store};
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::broadcast;
use uuid::Uuid;

use event::DEFAULT_EVENT_CAPACITY;

use crate::storage::{LibsqlMemoryStore, MemoryStore, NewMemory};
use crate::temporal::Validity;
use crate::{MemoryError, RRF_K, Ranking, Result, now_unix, rrf_fuse};

/// Borne la taille d'un texte mémorisé (octets). Au-delà, un item démesuré
/// saturerait le prompt de consolidation (`MAX_EPISODES` ne borne que le
/// *nombre* d'épisodes, pas leur taille individuelle) — DoS de contexte.
/// Cohérent avec la limite documentée côté REST (`openapi-sidecar.yaml`).
pub const MAX_TEXT_LEN: usize = 65_536;

/// Provenance par défaut d'un souvenir mémorisé directement par l'agent (par
/// opposition à `"consolidation"`, faits promus par le pipeline LLM).
const SOURCE_USER: &str = "user";

/// Provenance des faits promus par consolidation (vs [`SOURCE_USER`]). Référence
/// unique partagée avec `cognition::consolidation` : c'est elle qui distingue un
/// événement [`MemoryEventKind::Consolidated`] d'un [`MemoryEventKind::Remembered`].
pub(crate) const SOURCE_CONSOLIDATION: &str = "consolidation";

/// Mémoire d'un agent : moteur de stockage (vecteur natif) + embedder,
/// scellés par un [`AgentId`]. Le chiffrement est obligatoire (ADR-007).
pub struct Memory {
    engine: Arc<LibsqlMemoryStore>,
    embedder: Box<dyn Embedder>,
    agent: AgentId,
    /// Diffuseur d'événements mémoire (abonnements temps réel). Émis **après**
    /// commit d'une écriture. Bon marché à conserver/cloner. `send` sans abonné
    /// renvoie `Err` — ignoré (best-effort, cf. [`event`]).
    events: broadcast::Sender<MemoryEvent>,
}

impl Memory {
    /// Assemble une mémoire à partir des primitives du core déjà construites,
    /// **sans** migrer le schéma (à utiliser quand le schéma est déjà en place).
    #[must_use]
    pub fn new(store: Store, embedder: Box<dyn Embedder>, agent: AgentId) -> Self {
        let (events, _) = broadcast::channel(DEFAULT_EVENT_CAPACITY);
        Self {
            engine: Arc::new(LibsqlMemoryStore::new(store)),
            embedder,
            agent,
            events,
        }
    }

    /// Ouvre une mémoire : vérifie le chiffrement, applique le schéma
    /// (`memory` + index vecteur natif), puis renvoie la façade scellée par `agent`.
    ///
    /// Le chiffrement est **obligatoire** pour les stores sur fichier (ADR-007) :
    /// un store `:memory:` est éphémère, la règle ne s'y applique pas.
    ///
    /// # Errors
    /// [`crate::MemoryError::EncryptionRequired`] si le store est sur fichier et non chiffré.
    /// [`crate::MemoryError::Core`] si la migration échoue.
    pub async fn open(store: Store, embedder: Box<dyn Embedder>, agent: AgentId) -> Result<Self> {
        if store.path().is_some() && !store.is_encrypted() {
            return Err(crate::MemoryError::EncryptionRequired);
        }
        store.migrate(&schema::schema()).await?;
        Ok(Self::new(store, embedder, agent))
    }

    /// L'agent propriétaire de cette mémoire.
    #[must_use]
    pub fn agent(&self) -> &AgentId {
        &self.agent
    }

    /// S'abonne au flux d'événements mémoire de **cet** agent (et d'une couche
    /// donnée, si `layer` est fourni). L'abonnement renvoyé n'expose jamais le
    /// canal brut : l'isolation par agent/couche est appliquée côté serveur dans
    /// [`MemorySubscription::recv`], jamais déléguée à l'appelant.
    ///
    /// `agent_id` est capturé tel quel : un appelant qui passe l'identifiant
    /// d'un autre agent ne reçoit que les événements de cet autre agent — il ne
    /// peut pas remonter au-delà de ce que [`Memory`] émet, et chaque `Memory`
    /// n'émet que pour son propre agent. La sécurité multi-tenant repose sur
    /// l'isolation SQL en amont (ADR-006) ; ce filtre la prolonge au flux.
    #[must_use]
    pub fn watch(&self, agent_id: &str, layer: Option<MemoryLayer>) -> MemorySubscription {
        MemorySubscription::new(self.events.subscribe(), agent_id.to_string(), layer)
    }

    /// Émet un événement mémoire vers les abonnés. **Best-effort** : un `send`
    /// sans récepteur vivant renvoie `Err` — attendu (personne n'écoute), jamais
    /// propagé. À n'appeler **qu'après** commit de l'écriture concernée.
    fn emit(&self, kind: MemoryEventKind, layer: MemoryLayer, id: &str) {
        let _ = self.events.send(MemoryEvent {
            agent_id: self.agent.as_str().to_string(),
            kind,
            layer,
            id: id.to_string(),
        });
    }

    /// Moteur de stockage sous-jacent, vu à travers le contrat [`MemoryStore`].
    /// `pub(crate)` : la consolidation (même crate) lit les épisodes et
    /// construit un `Graph` dessus, sans exposer le moteur au public.
    pub(crate) fn engine(&self) -> Arc<dyn MemoryStore> {
        Arc::clone(&self.engine) as Arc<dyn MemoryStore>
    }

    /// Moteur de stockage **concret**. `pub(crate)` : réservé à
    /// `memory::porting` (export/import JSONL), qui a besoin de colonnes hors
    /// du contrat sémantique [`MemoryStore`] (cf. [`LibsqlMemoryStore::store`]).
    pub(crate) fn libsql_engine(&self) -> &LibsqlMemoryStore {
        &self.engine
    }

    /// Façade graphe sur le **même** moteur, scellée par le **même** agent.
    ///
    /// Permet aux consommateurs externes (MCP, REST, bindings) de traverser le
    /// graphe entités/relations (`recall_graph`) sans accéder au moteur, tout
    /// en conservant l'isolation par agent au niveau SQL (ADR-006).
    #[must_use]
    pub fn graph(&self) -> crate::Graph {
        crate::Graph::new(self.engine(), self.agent.clone())
    }

    /// Ouvre une mémoire **éphémère, non chiffrée** (`:memory:`) dotée d'un
    /// embedder déterministe sans modèle ([`HashEmbedder`]).
    ///
    /// Réservé aux **tests et aux spikes des bindings** : ni Candle, ni fichiers
    /// modèle, ni CMake — un roundtrip remember/recall fonctionne hors-ligne.
    /// **Jamais en production** (vecteurs non sémantiques). Le store `:memory:`
    /// est éphémère : la règle de chiffrement obligatoire ne s'y applique pas.
    ///
    /// # Errors
    /// [`crate::MemoryError::MissingAgent`] si `agent_id` est vide ;
    /// [`crate::MemoryError::Core`] si l'ouverture/migration échoue.
    #[cfg(feature = "test-util")]
    pub async fn open_in_memory(agent_id: &str) -> Result<Self> {
        let agent = AgentId::new(agent_id).ok_or(crate::MemoryError::MissingAgent)?;
        let store = Store::open_in_memory().await?;
        Self::open(store, Box::new(HashEmbedder::new()), agent).await
    }

    /// Mémorise un texte dans une couche, valide dès maintenant et sans
    /// expiration. Renvoie l'identifiant (UUID v4) du souvenir créé.
    ///
    /// # Errors
    /// Propage les erreurs d'embedding/stockage.
    pub async fn remember(&self, text: &str, layer: MemoryLayer) -> Result<String> {
        let now = now_unix();
        self.remember_with(text, layer, Validity::since(now)).await
    }

    /// Mémorise un texte avec une fenêtre de validité explicite. Renvoie
    /// l'identifiant (UUID v4) du souvenir créé — les consommateurs (MCP, REST,
    /// bindings) le retournent à l'appelant pour invalidation/effacement ultérieurs.
    ///
    /// L'insertion `memory` + miroir FTS est **atomique** ([`Store::begin_write`]) :
    /// jamais de souvenir visible par vecteur mais invisible en BM25, ou l'inverse.
    ///
    /// # Errors
    /// [`MemoryError::TextTooLong`] si `text` dépasse [`MAX_TEXT_LEN`].
    /// Propage aussi les erreurs d'embedding/stockage.
    pub async fn remember_with(&self, text: &str, layer: MemoryLayer, validity: Validity) -> Result<String> {
        self.remember_with_source(text, layer, validity, SOURCE_USER).await
    }

    /// Comme [`Memory::remember_with`], mais trace explicitement la `source`
    /// du souvenir (`"user"` pour un appel direct de l'agent, `"consolidation"`
    /// pour un fait promu par le pipeline LLM, ADR-018 / audit sécurité —
    /// memory poisoning). `pub(crate)` : la provenance n'est pas (encore)
    /// exposée à l'API publique de recall, seulement tracée en base.
    ///
    /// # Errors
    /// [`MemoryError::TextTooLong`] si `text` dépasse [`MAX_TEXT_LEN`].
    /// Propage aussi les erreurs d'embedding/stockage.
    pub(crate) async fn remember_with_source(
        &self,
        text: &str,
        layer: MemoryLayer,
        validity: Validity,
        source: &str,
    ) -> Result<String> {
        check_text_len(text)?;
        let vector = self.embedder.embed(text)?;
        let id = Uuid::new_v4().to_string();
        self.engine
            .put_memory(&id, &self.agent, layer, text, validity, &vector, source)
            .await?;
        // Émis après commit : un souvenir visible est annoncé, jamais l'inverse.
        // Un fait promu par consolidation (`source = "consolidation"`) porte le
        // genre `Consolidated` ; un souvenir direct, `Remembered`.
        let kind = if source == SOURCE_CONSOLIDATION {
            MemoryEventKind::Consolidated
        } else {
            MemoryEventKind::Remembered
        };
        self.emit(kind, layer, &id);
        Ok(id)
    }

    /// Mémorise un **lot** de textes dans une couche, valides dès maintenant et
    /// sans expiration. Renvoie les identifiants créés, dans l'ordre des textes.
    ///
    /// # Errors
    /// Propage les erreurs d'embedding/stockage.
    pub async fn remember_batch(&self, texts: &[String], layer: MemoryLayer) -> Result<Vec<String>> {
        let now = now_unix();
        self.remember_batch_with(texts, layer, Validity::since(now)).await
    }

    /// Mémorise un lot avec une fenêtre de validité explicite : **une** passe
    /// d'embedding ([`Embedder::embed_batch`]) et **une** transaction — le lot
    /// devient visible d'un coup, ou pas du tout. C'est le chemin de
    /// l'ingestion initiale (import d'historique, seed de connaissances).
    ///
    /// # Errors
    /// [`MemoryError::TextTooLong`] si un texte du lot dépasse [`MAX_TEXT_LEN`]
    /// (fail-fast : le premier texte trop long stoppe le lot, rien n'est inséré
    /// puisque la validation précède l'embedding/la transaction).
    /// Propage aussi les erreurs d'embedding/stockage.
    pub async fn remember_batch_with(
        &self,
        texts: &[String],
        layer: MemoryLayer,
        validity: Validity,
    ) -> Result<Vec<String>> {
        self.remember_batch_with_source(texts, layer, validity, SOURCE_USER)
            .await
    }

    /// Comme [`Memory::remember_batch_with`], mais trace explicitement la
    /// `source` du lot (cf. [`Memory::remember_with_source`]).
    ///
    /// # Errors
    /// [`MemoryError::TextTooLong`] si un texte du lot dépasse [`MAX_TEXT_LEN`].
    /// Propage aussi les erreurs d'embedding/stockage.
    pub(crate) async fn remember_batch_with_source(
        &self,
        texts: &[String],
        layer: MemoryLayer,
        validity: Validity,
        source: &str,
    ) -> Result<Vec<String>> {
        if texts.is_empty() {
            return Ok(Vec::new());
        }
        for text in texts {
            check_text_len(text)?;
        }
        let vectors = self.embedder.embed_batch(texts)?;
        let ids: Vec<String> = texts.iter().map(|_| Uuid::new_v4().to_string()).collect();
        let items: Vec<NewMemory<'_>> = texts
            .iter()
            .zip(&vectors)
            .zip(&ids)
            .map(|((text, vector), id)| NewMemory {
                id: id.clone(),
                layer,
                text,
                validity,
                vector,
                source,
            })
            .collect();
        self.engine.put_memory_batch(&self.agent, &items).await?;
        // Émis après commit du lot : un événement par souvenir inséré.
        let kind = if source == SOURCE_CONSOLIDATION {
            MemoryEventKind::Consolidated
        } else {
            MemoryEventKind::Remembered
        };
        for id in &ids {
            self.emit(kind, layer, id);
        }
        Ok(ids)
    }

    /// Recall temporel : pertinent ET valide, borné à cet agent.
    ///
    /// L'isolation (`agent_id`) et le filtre temporel sont appliqués par le
    /// moteur de stockage ([`MemoryStore::recall_vector`]) — `Memory` ne
    /// connaît plus le SQL, seulement le vecteur de requête et l'agent.
    ///
    /// # Errors
    /// Propage les erreurs d'embedding/recherche.
    pub async fn recall(&self, query: &str, k: usize) -> Result<Vec<Record>> {
        let qvec = self.embedder.embed(query)?;
        let now = now_unix();
        self.engine
            .recall_vector(&self.agent, &qvec, k, None, Metric::Cosine, now)
            .await
    }

    /// Recall sémantique temporel avec **métrique explicite** ([`Metric`]).
    ///
    /// [`Metric::Cosine`] emprunte le chemin natif ; [`Metric::Euclidean`] et
    /// [`Metric::Hamming`] sur-échantillonnent les candidats cosinus puis sont
    /// re-classées en Rust (ADR-012). Met à jour `last_access` sur les résultats.
    ///
    /// # Errors
    /// Propage les erreurs d'embedding/recherche.
    pub async fn recall_with_metric(&self, query: &str, k: usize, metric: Metric) -> Result<Vec<Record>> {
        let qvec = self.embedder.embed(query)?;
        let now = now_unix();
        self.engine
            .recall_vector(&self.agent, &qvec, k, None, metric, now)
            .await
    }

    /// Recall **hybride** (ADR-014) : fusionne le classement **vectoriel** et le
    /// classement **BM25** (full-text natif libSQL) par Reciprocal Rank Fusion
    /// ([`rrf_fuse`]). Un terme exact que l'embedding rate (sigle, identifiant
    /// rare, nom propre) remonte par BM25 ; une reformulation que les mots-clés
    /// ratent remonte par le vecteur. Borné à l'agent et à la validité.
    /// Met à jour `last_access` sur les résultats.
    ///
    /// Le `score` du [`Record`] retourné porte le **score RRF fusionné**, pas la
    /// similarité cosinus.
    ///
    /// # Errors
    /// Propage les erreurs d'embedding/recherche/stockage.
    pub async fn recall_hybrid(&self, query: &str, k: usize) -> Result<Vec<Record>> {
        // Sur-échantillonne chaque signal pour une fusion plus riche.
        let inner = k.saturating_mul(4).max(k);
        let now = now_unix();
        let qvec = self.embedder.embed(query)?;

        let vector_ids = self.engine.vector_ranking_ids(&self.agent, &qvec, inner, now).await?;
        let keyword_ids = match fts_match_expr(query) {
            Some(match_expr) => {
                self.engine
                    .keyword_ranking_ids(&self.agent, &match_expr, inner, now)
                    .await?
            }
            None => Vec::new(),
        };

        let fused = rrf_fuse(
            &[
                Ranking {
                    signal: "vector".to_string(),
                    ids: vector_ids,
                },
                Ranking {
                    signal: "keyword".to_string(),
                    ids: keyword_ids,
                },
            ],
            RRF_K,
        );

        let top_ids: Vec<String> = fused.iter().take(k).map(|f| f.id.clone()).collect();
        #[allow(clippy::cast_possible_truncation)]
        let scores: HashMap<&str, f32> = fused.iter().take(k).map(|f| (f.id.as_str(), f.score as f32)).collect();

        let hydrated = self.engine.hydrate(&self.agent, &top_ids, now).await?;
        Ok(hydrated
            .into_iter()
            .map(|h| {
                let score = scores.get(h.id.as_str()).copied().unwrap_or(0.0);
                Record {
                    id: h.id,
                    text: h.text,
                    layer: h.layer,
                    score,
                }
            })
            .collect())
    }

    /// Recall filtré sur une couche unique. Met à jour `last_access` sur chaque
    /// souvenir retourné (l'oubli adaptatif en dépend).
    ///
    /// # Errors
    /// Propage les erreurs d'embedding/recherche.
    pub async fn recall_by_layer(&self, query: &str, layer: MemoryLayer, k: usize) -> Result<Vec<Record>> {
        let qvec = self.embedder.embed(query)?;
        let now = now_unix();
        self.engine
            .recall_vector(&self.agent, &qvec, k, Some(layer), Metric::Cosine, now)
            .await
    }

    /// Invalide un souvenir en fixant `valid_until = now()`. Il n'apparaît plus
    /// dans les recalls futurs mais reste physiquement en base.
    ///
    /// # Errors
    /// Propage les erreurs de stockage.
    pub async fn invalidate(&self, id: &str) -> Result<()> {
        // Capturer la couche AVANT l'invalidation : le souvenir reste en base
        // (seul `valid_until` change), donc lisible. `None` ⇒ aucun souvenir de
        // cet agent ⇒ no-op silencieux, aucun événement (pas de fuite cross-agent).
        let layer = self.engine.layer_of(&self.agent, id).await?;
        self.engine.invalidate(&self.agent, id, now_unix()).await?;
        if let Some(layer) = layer {
            self.emit(MemoryEventKind::Invalidated, layer, id);
        }
        Ok(())
    }

    /// Suppression physique d'un souvenir (RGPD, droit à l'effacement).
    /// Atomique : la ligne `memory` et son miroir FTS disparaissent ensemble.
    ///
    /// # Errors
    /// Propage les erreurs de stockage.
    pub async fn forget(&self, id: &str) -> Result<()> {
        // Capturer la couche AVANT l'effacement physique (après, la ligne a
        // disparu). `None` ⇒ rien à effacer pour cet agent ⇒ aucun événement.
        let layer = self.engine.layer_of(&self.agent, id).await?;
        self.engine.forget(&self.agent, id).await?;
        if let Some(layer) = layer {
            self.emit(MemoryEventKind::Forgotten, layer, id);
        }
        Ok(())
    }

    /// Purge **toutes** les données de cet agent : souvenirs (`memory`), entités
    /// (`entity`) et relations (`edge`). Irréversible (RGPD, droit à l'oubli).
    /// Idempotent : ne renvoie pas d'erreur si l'agent n'a aucune donnée.
    /// Atomique : pas de purge partielle possible (tout ou rien).
    ///
    /// # Errors
    /// Propage les erreurs de stockage.
    pub async fn purge_agent(&self) -> Result<()> {
        self.engine.purge_agent(&self.agent).await
    }

    /// Statistiques des souvenirs valides de cet agent, par couche.
    ///
    /// # Errors
    /// Propage les erreurs de stockage.
    pub async fn stats(&self) -> Result<AgentStats> {
        self.engine.agent_stats(&self.agent, now_unix()).await
    }

    /// Recall vectoriel limité aux souvenirs dont le contenu mentionne une entité
    /// du graphe (P2). Met à jour `last_access` sur les résultats.
    ///
    /// # Errors
    /// Propage les erreurs d'embedding/recherche.
    pub async fn search_graph(&self, query: &str, k: usize) -> Result<Vec<Record>> {
        let qvec = self.embedder.embed(query)?;
        let now = now_unix();
        self.engine.recall_graph_filtered(&self.agent, &qvec, k, now).await
    }
}

/// Rejette un texte dépassant [`MAX_TEXT_LEN`] (DoS de contexte, audit sécurité).
fn check_text_len(text: &str) -> Result<()> {
    let len = text.len();
    if len > MAX_TEXT_LEN {
        return Err(MemoryError::TextTooLong { len, max: MAX_TEXT_LEN });
    }
    Ok(())
}

/// Construit une expression FTS5 MATCH sûre depuis une requête libre : tokens
/// alphanumériques, chacun cité (literal, donc insensible aux mots-clés FTS5
/// comme AND/OR/NEAR) et joints par OR (orienté rappel). `None` si aucun token.
fn fts_match_expr(query: &str) -> Option<String> {
    let tokens: Vec<String> = query
        .split(|c: char| !c.is_alphanumeric())
        .filter(|t| !t.is_empty())
        .take(32)
        .map(|t| format!("\"{}\"", t.to_lowercase()))
        .collect();
    if tokens.is_empty() {
        None
    } else {
        Some(tokens.join(" OR "))
    }
}