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 recall_view;
79pub mod retrieval_failure_logger;
80pub mod scenes;
81pub mod tiers;
82
83pub mod db_vector_store;
84pub mod embedding_registry;
85pub mod embedding_store;
86pub mod error;
87pub mod eviction;
88pub mod graph;
89pub mod in_memory_store;
90pub mod qdrant_ops;
91pub mod quality_gate;
92pub mod response_cache;
93pub mod router;
94pub mod semantic;
95pub mod snapshot;
96pub mod store;
97#[cfg(any(test, feature = "testing"))]
98pub mod testing;
99pub mod token_counter;
100pub mod types;
101pub mod vector_store;
102
103pub use admission::{
104    AdmissionControl, AdmissionDecision, AdmissionFactors, AdmissionRejected, AdmissionWeights,
105    GoalGateConfig, compute_content_type_prior, compute_factual_confidence, log_admission_decision,
106};
107pub use anchored_summary::AnchoredSummary;
108pub use compaction_probe::{
109    CategoryScore, CompactionProbeResult, ProbeQuestion, ProbeVerdict, answer_probe_questions,
110    generate_probe_questions, score_answers, validate_compaction,
111};
112pub use compression::{
113    CompressionLevel, RetrievalPolicy,
114    promotion::{
115        PromotionCandidate, PromotionConfig, PromotionEngine, PromotionInput, SkillWriter,
116    },
117};
118pub use compression_guidelines::{
119    build_guidelines_update_prompt, sanitize_guidelines, start_guidelines_updater,
120    truncate_to_token_budget, update_guidelines_once,
121};
122pub use consolidation::{
123    ConsolidationConfig, ConsolidationResult, TopologyOp, run_consolidation_sweep,
124    start_consolidation_loop,
125};
126#[cfg(feature = "pdf")]
127pub use document::PdfLoader;
128pub use document::{
129    Chunk, Document, DocumentError, DocumentLoader, DocumentMetadata, IngestionPipeline,
130    SplitterConfig, TextLoader, TextSplitter,
131};
132pub use embedding_registry::{
133    EmbedFuture, Embeddable, EmbeddingRegistry, EmbeddingRegistryError, SyncStats,
134};
135pub use embedding_store::ensure_qdrant_collection;
136pub use error::MemoryError;
137pub use eviction::{EbbinghausPolicy, EvictionPolicy, start_eviction_loop};
138pub use facade::{
139    CompactionContext, CompactionResult, InMemoryFacade, MemoryEntry, MemoryFacade, MemoryMatch,
140    MemorySource,
141};
142pub use forgetting::{ForgettingConfig, ForgettingResult, start_forgetting_loop};
143pub use graph::EntityLockManager;
144pub use graph::experience::{EvolutionSweepStats, ExperienceStore};
145pub use graph::{
146    BeliefRevisionConfig, Community, Edge, EdgeType, Entity, EntityType, GraphFact, GraphStore,
147    RpeRouter, RpeSignal, extract_candidate_entities,
148};
149pub use hebbian_consolidation::{
150    GraphRule, HebbianConsolidationCandidate, HebbianConsolidationOutcome,
151    run_consolidation_sweep as run_hebbian_consolidation_sweep,
152    spawn_consolidation_loop as spawn_hebbian_consolidation_loop,
153};
154pub use qdrant_ops::QdrantOps;
155pub use reasoning::{
156    Outcome, ProcessTurnConfig, ReasoningMemory, ReasoningStrategy, SelfJudgeOutcome,
157    distill_strategy, process_turn as process_reasoning_turn, run_self_judge,
158};
159pub use recall_view::{RecallView, RecalledFact};
160pub use response_cache::ResponseCache;
161pub use retrieval_failure_logger::RetrievalFailureLogger;
162pub use router::{
163    AsyncMemoryRouter, HeuristicRouter, HybridRouter, LlmRouter, MemoryRoute, MemoryRouter,
164    RoutingDecision, TemporalRange, classify_graph_subgraph, parse_route_str,
165    strip_temporal_keywords,
166};
167pub use scenes::{
168    MemScene, SceneConfig, consolidate_scenes, list_scenes, start_scene_consolidation_loop,
169};
170pub use semantic::{
171    BufferedWrite, EmbedContext, ExtractionResult, ExtractionStats, GraphExtractionConfig,
172    HebbianReinforcement, HelaSpreadRuntime, ImportanceScoring, LinkingStats, MmrReranking,
173    NoteLinkingConfig, PersonaExtractionConfig, QueryBiasCorrection, RecalledMessage,
174    StructuredSummary, TemporalDecay, TrajectoryEntry, TrajectoryExtractionConfig,
175    TreeConsolidationConfig, TreeConsolidationResult, WriteBuffer, build_summarization_prompt,
176    contains_self_referential_language, extract_and_store, extract_persona_facts,
177    extract_trajectory_entries, link_memory_notes, run_tree_consolidation_sweep,
178    start_tree_consolidation_loop,
179};
180pub use snapshot::{ImportStats, MemorySnapshot, export_snapshot, import_snapshot};
181pub use store::compression_guidelines::CompressionFailurePair;
182pub use store::corrections::UserCorrectionRow;
183pub use store::experiments::{ExperimentResultRow, NewExperimentResult, SessionSummaryRow};
184pub use store::memory_tree::MemoryTreeRow;
185pub use store::persona::PersonaFactRow;
186pub use store::retrieval_failures::{RetrievalFailureRecord, RetrievalFailureType};
187pub use store::session_digest::SessionDigest;
188pub use store::trajectory::{NewTrajectoryEntry, TrajectoryEntryRow};
189pub use tiers::{TierPromotionConfig, start_tier_promotion_loop};
190pub use token_counter::TokenCounter;
191pub use tokio_util::sync::CancellationToken;
192pub use types::{ConversationId, MemSceneId, MemoryTier, MessageId};
193pub use vector_store::{
194    FieldCondition, FieldValue, ScoredVectorPoint, VectorFilter, VectorPoint, VectorStore,
195    VectorStoreError,
196};
197pub use zeph_common::config::memory::HebbianConsolidationConfig;
198pub use zeph_config::memory::CompressionGuidelinesConfig;
199pub use zeph_config::memory::EvictionConfig;
200pub use zeph_config::memory::{CompactionProbeConfig, ProbeCategory};