Skip to main content

zeph_memory/
lib.rs

1// SPDX-FileCopyrightText: 2026 Andrei G <bug-ops>
2// SPDX-License-Identifier: MIT OR Apache-2.0
3
4//! Semantic memory layer for the Zeph agent.
5//!
6//! `zeph-memory` implements a two-backend hybrid memory system:
7//!
8//! - **[`store::DbStore`]** (`SqliteStore`) — relational persistence for messages, summaries,
9//!   persona facts, trajectory entries, and session metadata.
10//! - **[`embedding_store::EmbeddingStore`]** — Qdrant-backed vector index for semantic recall.
11//!   Falls back gracefully to [`db_vector_store::DbVectorStore`] when Qdrant is unavailable.
12//!
13//! The high-level entry point is [`semantic::SemanticMemory`], which combines both backends
14//! and exposes `remember` / `recall` / `summarize` operations consumed by `zeph-core`.
15//!
16//! # Architecture overview
17//!
18//! ```text
19//! SemanticMemory
20//! ├── SqliteStore  ── messages, summaries, corrections, persona, trajectory …
21//! └── EmbeddingStore ── Qdrant (primary) / DbVectorStore (fallback)
22//!         └── QdrantOps  ── thin gRPC wrapper over qdrant-client
23//! ```
24//!
25//! # Memory tiers
26//!
27//! Messages are classified into four tiers (see [`types::MemoryTier`]):
28//!
29//! | Tier | Description |
30//! |------|-------------|
31//! | `Working` | Current context window; never persisted. |
32//! | `Episodic` | Per-session messages stored in `SQLite`. |
33//! | `Semantic` | Cross-session distilled facts promoted from episodic. |
34//! | `Persona` | Long-lived user attributes (preferences, domain knowledge). |
35//!
36//! # Admission control
37//!
38//! Each `remember()` call is gated by [`admission::AdmissionControl`] (A-MAC, #2317), which
39//! evaluates five factors (future utility, factual confidence, semantic novelty, temporal
40//! recency, content-type prior) and rejects low-value messages before they reach the DB.
41//!
42//! # Memory routing
43//!
44//! [`router::HybridRouter`] classifies each recall query and dispatches to the appropriate
45//! backend: keyword (`SQLite` FTS5), semantic (Qdrant), graph (BFS traversal), episodic
46//! (timestamp-filtered FTS5), or hybrid (reciprocal-rank fusion of keyword + semantic).
47//!
48//! # Background loops
49//!
50//! Several background tasks maintain memory health:
51//!
52//! - [`eviction::start_eviction_loop`] — Ebbinghaus-curve eviction.
53//! - [`forgetting::start_forgetting_loop`] — `SleepGate` importance downscaling.
54//! - [`consolidation::start_consolidation_loop`] — cross-session fact merging.
55//! - [`tiers::start_tier_promotion_loop`] — Episodic → Semantic promotion.
56//! - [`semantic::start_tree_consolidation_loop`] — hierarchical note consolidation.
57//! - [`hebbian_consolidation::spawn_consolidation_loop`] — HL-F3/F4 cluster distillation.
58//!
59//! # Feature flags
60//!
61//! | Feature | Description |
62//! |---------|-------------|
63//! | `sqlite` (default) | Enable SQLite persistence via `zeph-db`. |
64//! | `pdf` | Enable `PdfLoader` for PDF ingestion. |
65//! | `postgres` | Enable PostgreSQL support via `zeph-db`. |
66
67pub mod admission;
68pub mod anchored_summary;
69pub mod compaction_probe;
70pub mod compression;
71pub mod compression_guidelines;
72pub mod consolidation;
73pub mod document;
74pub mod facade;
75pub mod forgetting;
76pub mod hebbian_consolidation;
77pub mod reasoning;
78pub mod scenes;
79pub mod tiers;
80
81pub mod db_vector_store;
82pub mod embedding_registry;
83pub mod embedding_store;
84pub mod error;
85pub mod eviction;
86pub mod graph;
87pub mod in_memory_store;
88pub mod qdrant_ops;
89pub mod quality_gate;
90pub mod response_cache;
91pub mod router;
92pub mod semantic;
93pub mod snapshot;
94pub mod store;
95pub mod testing;
96pub mod token_counter;
97pub mod types;
98pub mod vector_store;
99
100pub use admission::{
101    AdmissionControl, AdmissionDecision, AdmissionFactors, AdmissionRejected, AdmissionWeights,
102    GoalGateConfig, compute_content_type_prior, compute_factual_confidence, log_admission_decision,
103};
104pub use anchored_summary::AnchoredSummary;
105pub use compaction_probe::{
106    CategoryScore, CompactionProbeConfig, CompactionProbeResult, ProbeCategory, ProbeQuestion,
107    ProbeVerdict, answer_probe_questions, generate_probe_questions, score_answers,
108    validate_compaction,
109};
110pub use compression::{
111    CompressionLevel, RetrievalPolicy,
112    promotion::{
113        PromotionCandidate, PromotionConfig, PromotionEngine, PromotionInput, SkillWriter,
114    },
115};
116pub use compression_guidelines::CompressionGuidelinesConfig;
117pub use compression_guidelines::{
118    build_guidelines_update_prompt, sanitize_guidelines, start_guidelines_updater,
119    truncate_to_token_budget, update_guidelines_once,
120};
121pub use consolidation::{
122    ConsolidationConfig, ConsolidationResult, TopologyOp, run_consolidation_sweep,
123    start_consolidation_loop,
124};
125#[cfg(feature = "pdf")]
126pub use document::PdfLoader;
127pub use document::{
128    Chunk, Document, DocumentError, DocumentLoader, DocumentMetadata, IngestionPipeline,
129    SplitterConfig, TextLoader, TextSplitter,
130};
131pub use embedding_registry::{
132    EmbedFuture, Embeddable, EmbeddingRegistry, EmbeddingRegistryError, SyncStats,
133};
134pub use embedding_store::ensure_qdrant_collection;
135pub use error::MemoryError;
136pub use eviction::{EbbinghausPolicy, EvictionConfig, EvictionPolicy, start_eviction_loop};
137pub use facade::{
138    CompactionContext, CompactionResult, InMemoryFacade, MemoryEntry, MemoryFacade, MemoryMatch,
139    MemorySource,
140};
141pub use forgetting::{ForgettingConfig, ForgettingResult, start_forgetting_loop};
142pub use graph::EntityLockManager;
143pub use graph::experience::{EvolutionSweepStats, ExperienceStore};
144pub use graph::{
145    BeliefRevisionConfig, Community, Edge, EdgeType, Entity, EntityType, GraphFact, GraphStore,
146    RpeRouter, RpeSignal, extract_candidate_entities,
147};
148pub use hebbian_consolidation::{
149    GraphRule, HebbianConsolidationCandidate, HebbianConsolidationOutcome,
150    run_consolidation_sweep as run_hebbian_consolidation_sweep,
151    spawn_consolidation_loop as spawn_hebbian_consolidation_loop,
152};
153pub use qdrant_ops::QdrantOps;
154pub use reasoning::{
155    Outcome, ProcessTurnConfig, ReasoningMemory, ReasoningStrategy, SelfJudgeOutcome,
156    distill_strategy, process_turn as process_reasoning_turn, run_self_judge,
157};
158pub use response_cache::ResponseCache;
159pub use router::{
160    AsyncMemoryRouter, HeuristicRouter, HybridRouter, LlmRouter, MemoryRoute, MemoryRouter,
161    RoutingDecision, TemporalRange, classify_graph_subgraph, parse_route_str,
162    strip_temporal_keywords,
163};
164pub use scenes::{
165    MemScene, SceneConfig, consolidate_scenes, list_scenes, start_scene_consolidation_loop,
166};
167pub use semantic::{
168    BufferedWrite, EmbedContext, ExtractionResult, ExtractionStats, GraphExtractionConfig,
169    HelaSpreadRuntime, LinkingStats, NoteLinkingConfig, PersonaExtractionConfig, RecalledMessage,
170    StructuredSummary, TrajectoryEntry, TrajectoryExtractionConfig, TreeConsolidationConfig,
171    TreeConsolidationResult, WriteBuffer, build_summarization_prompt,
172    contains_self_referential_language, extract_and_store, extract_persona_facts,
173    extract_trajectory_entries, link_memory_notes, run_tree_consolidation_sweep,
174    start_tree_consolidation_loop,
175};
176pub use snapshot::{ImportStats, MemorySnapshot, export_snapshot, import_snapshot};
177pub use store::compression_guidelines::CompressionFailurePair;
178pub use store::corrections::UserCorrectionRow;
179pub use store::experiments::{ExperimentResultRow, NewExperimentResult, SessionSummaryRow};
180pub use store::memory_tree::MemoryTreeRow;
181pub use store::persona::PersonaFactRow;
182pub use store::session_digest::SessionDigest;
183pub use store::trajectory::{NewTrajectoryEntry, TrajectoryEntryRow};
184pub use tiers::{TierPromotionConfig, start_tier_promotion_loop};
185pub use token_counter::TokenCounter;
186pub use tokio_util::sync::CancellationToken;
187pub use types::{ConversationId, MemSceneId, MemoryTier, MessageId};
188pub use vector_store::{
189    FieldCondition, FieldValue, ScoredVectorPoint, VectorFilter, VectorPoint, VectorStore,
190    VectorStoreError,
191};
192pub use zeph_common::config::memory::HebbianConsolidationConfig;