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//! - [`episodic_consolidation::start_episodic_consolidation_loop`] — episodic → semantic fact extraction.
59//!
60//! # Feature flags
61//!
62//! | Feature | Description |
63//! |---------|-------------|
64//! | `sqlite` (default) | Enable SQLite persistence via `zeph-db`. |
65//! | `pdf` | Enable `PdfLoader` for PDF ingestion. |
66//! | `postgres` | Enable PostgreSQL support via `zeph-db`. |
67
68pub mod admission;
69pub mod anchored_summary;
70pub mod compaction_probe;
71pub mod compression;
72pub mod compression_guidelines;
73pub mod consolidation;
74pub mod document;
75pub mod episodic_consolidation;
76pub mod episodic_graph;
77pub mod facade;
78pub mod five_signal;
79pub mod forgetting;
80pub mod hebbian_consolidation;
81pub mod optical_forgetting;
82pub mod reasoning;
83pub mod recall_view;
84pub mod retrieval_failure_logger;
85pub mod scenes;
86pub mod tiered_retrieval;
87pub mod tiers;
88
89pub mod db_vector_store;
90pub mod embedding_registry;
91pub mod embedding_store;
92pub mod error;
93pub mod eviction;
94pub mod graph;
95pub mod in_memory_store;
96pub mod qdrant_ops;
97pub mod quality_gate;
98pub mod response_cache;
99pub mod router;
100pub mod semantic;
101pub mod shadow;
102pub mod snapshot;
103pub mod store;
104#[cfg(any(test, feature = "testing"))]
105pub mod testing;
106pub mod token_counter;
107pub mod types;
108pub mod vector_store;
109
110pub use admission::{
111    AdmissionControl, AdmissionDecision, AdmissionFactors, AdmissionRejected, AdmissionWeights,
112    GoalGateConfig, compute_content_type_prior, compute_factual_confidence, log_admission_decision,
113};
114pub use anchored_summary::AnchoredSummary;
115pub use compaction_probe::{
116    CategoryScore, CompactionProbeResult, ProbeQuestion, ProbeVerdict, answer_probe_questions,
117    generate_probe_questions, score_answers, validate_compaction,
118};
119pub use compression::{
120    CompressionLevel, RetrievalPolicy,
121    promotion::{
122        PromotionCandidate, PromotionConfig, PromotionEngine, PromotionInput, SkillWriter,
123    },
124};
125pub use compression_guidelines::{
126    build_guidelines_update_prompt, sanitize_guidelines, start_guidelines_updater,
127    truncate_to_token_budget, update_guidelines_once,
128};
129pub use consolidation::{
130    ConsolidationConfig, ConsolidationResult, TopologyOp, run_consolidation_sweep,
131    start_consolidation_loop,
132};
133#[cfg(feature = "pdf")]
134pub use document::PdfLoader;
135pub use document::{
136    Chunk, Document, DocumentError, DocumentLoader, DocumentMetadata, IngestionPipeline,
137    SplitterConfig, TextLoader, TextSplitter,
138};
139pub use embedding_registry::{
140    EmbedFuture, Embeddable, EmbeddingRegistry, EmbeddingRegistryError, SyncStats,
141};
142pub use embedding_store::ensure_qdrant_collection;
143pub use episodic_consolidation::{
144    EpisodicConsolidationConfig, EpisodicConsolidationResult, run_episodic_consolidation_sweep,
145    start_episodic_consolidation_loop,
146};
147pub use episodic_graph::{
148    CausalLink, EmGraphConfig, EpisodicEvent, extract_events, fetch_recent_events, link_events,
149    recall_episodic_causal, store_events, store_links,
150};
151pub use error::MemoryError;
152pub use eviction::{EbbinghausPolicy, EvictionPolicy, start_eviction_loop};
153pub use facade::{
154    CompactionContext, CompactionResult, InMemoryFacade, MemoryEntry, MemoryFacade, MemoryMatch,
155    MemorySource,
156};
157pub use forgetting::{ForgettingConfig, ForgettingResult, start_forgetting_loop};
158pub use graph::EntityLockManager;
159pub use graph::experience::{EvolutionSweepStats, ExperienceStore};
160pub use graph::{
161    BeliefMemConfig, BeliefRevisionConfig, BeliefStore, Community, Edge, EdgeType, Entity,
162    EntityType, GraphFact, GraphStore, PendingBelief, RpeRouter, RpeSignal,
163    extract_candidate_entities, noisy_or, time_decayed_prob,
164};
165pub use hebbian_consolidation::{
166    GraphRule, HebbianConsolidationCandidate, HebbianConsolidationOutcome,
167    run_consolidation_sweep as run_hebbian_consolidation_sweep,
168    spawn_consolidation_loop as spawn_hebbian_consolidation_loop,
169};
170pub use optical_forgetting::{
171    ContentFidelity, OpticalForgettingConfig, OpticalForgettingResult,
172    run_optical_forgetting_sweep, start_optical_forgetting_loop,
173};
174pub use qdrant_ops::QdrantOps;
175pub use reasoning::{
176    Outcome, ProcessTurnConfig, ReasoningMemory, ReasoningStrategy, SelfJudgeOutcome,
177    distill_strategy, process_turn as process_reasoning_turn, run_self_judge,
178};
179pub use recall_view::{RecallView, RecalledFact};
180pub use response_cache::ResponseCache;
181pub use retrieval_failure_logger::RetrievalFailureLogger;
182pub use router::{
183    AsyncMemoryRouter, HeuristicRouter, HybridRouter, LlmRouter, MemoryRoute, MemoryRouter,
184    RoutingDecision, TemporalRange, classify_graph_subgraph, parse_route_str,
185    strip_temporal_keywords,
186};
187pub use scenes::{
188    MemScene, SceneConfig, consolidate_scenes, list_scenes, start_scene_consolidation_loop,
189};
190pub use semantic::{
191    BufferedWrite, EmbedContext, ExtractionResult, ExtractionStats, GraphExtractionConfig,
192    HebbianReinforcement, HelaSpreadRuntime, ImportanceScoring, LinkingStats, MmrReranking,
193    NoteLinkingConfig, PersonaExtractionConfig, QueryBiasCorrection, RecalledMessage,
194    StructuredSummary, TemporalDecay, TrajectoryEntry, TrajectoryExtractionConfig,
195    TreeConsolidationConfig, TreeConsolidationResult, WriteBuffer, build_summarization_prompt,
196    contains_self_referential_language, extract_and_store, extract_persona_facts,
197    extract_trajectory_entries, link_memory_notes, run_tree_consolidation_sweep,
198    start_tree_consolidation_loop,
199};
200pub use snapshot::{ImportStats, MemorySnapshot, export_snapshot, import_snapshot};
201pub use store::agent_sessions::{AgentSessionRow, SessionChannel, SessionKind, SessionStatus};
202pub use store::compression_guidelines::CompressionFailurePair;
203pub use store::corrections::UserCorrectionRow;
204pub use store::experiments::{ExperimentResultRow, NewExperimentResult, SessionSummaryRow};
205pub use store::memory_tree::MemoryTreeRow;
206pub use store::persona::PersonaFactRow;
207pub use store::retrieval_failures::{RetrievalFailureRecord, RetrievalFailureType};
208pub use store::session_digest::SessionDigest;
209pub use store::trajectory::{NewTrajectoryEntry, TrajectoryEntryRow};
210pub use tiered_retrieval::{
211    IntentClass, TieredRetrievalConfig, TieredRetrievalResult, recall_tiered,
212};
213pub use tiers::{TierPromotionConfig, start_tier_promotion_loop};
214pub use token_counter::TokenCounter;
215pub use tokio_util::sync::CancellationToken;
216pub use types::{ConversationId, EntityId, ExperienceId, MemSceneId, MemoryTier, MessageId};
217pub use vector_store::{
218    FieldCondition, FieldValue, ScoredVectorPoint, VectorFilter, VectorPoint, VectorStore,
219    VectorStoreError,
220};
221pub use zeph_common::config::memory::HebbianConsolidationConfig;
222pub use zeph_common::memory::TokenCounting;
223pub use zeph_config::memory::CompressionGuidelinesConfig;
224pub use zeph_config::memory::EvictionConfig;
225pub use zeph_config::memory::{CompactionProbeConfig, ProbeCategory};