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//!
58//! # Feature flags
59//!
60//! | Feature | Description |
61//! |---------|-------------|
62//! | `sqlite` (default) | Enable SQLite persistence via `zeph-db`. |
63//! | `pdf` | Enable `PdfLoader` for PDF ingestion. |
64//! | `postgres` | Enable PostgreSQL support via `zeph-db`. |
65
66pub mod admission;
67pub mod admission_rl;
68pub mod anchored_summary;
69pub mod compaction_probe;
70pub mod compression_guidelines;
71pub mod compression_predictor;
72pub mod consolidation;
73pub mod document;
74pub mod facade;
75pub mod forgetting;
76pub mod scenes;
77pub mod tiers;
78
79pub mod db_vector_store;
80pub mod embedding_registry;
81pub mod embedding_store;
82pub mod error;
83pub mod eviction;
84pub mod graph;
85pub mod in_memory_store;
86pub mod qdrant_ops;
87pub mod quality_gate;
88pub mod response_cache;
89pub mod router;
90pub mod semantic;
91pub mod snapshot;
92pub mod store;
93pub mod testing;
94pub mod token_counter;
95pub mod types;
96pub mod vector_store;
97
98pub use admission::{
99    AdmissionControl, AdmissionDecision, AdmissionFactors, AdmissionRejected, AdmissionWeights,
100    GoalGateConfig, compute_content_type_prior, compute_factual_confidence, log_admission_decision,
101};
102pub use anchored_summary::AnchoredSummary;
103pub use compaction_probe::{
104    CategoryScore, CompactionProbeConfig, CompactionProbeResult, ProbeCategory, ProbeQuestion,
105    ProbeVerdict, answer_probe_questions, generate_probe_questions, score_answers,
106    validate_compaction,
107};
108pub use compression_guidelines::CompressionGuidelinesConfig;
109pub use compression_guidelines::{
110    build_guidelines_update_prompt, sanitize_guidelines, start_guidelines_updater,
111    truncate_to_token_budget, update_guidelines_once,
112};
113pub use compression_predictor::{
114    CompressionFeatures, CompressionModelWeights, CompressionPredictor,
115};
116pub use consolidation::{
117    ConsolidationConfig, ConsolidationResult, TopologyOp, run_consolidation_sweep,
118    start_consolidation_loop,
119};
120#[cfg(feature = "pdf")]
121pub use document::PdfLoader;
122pub use document::{
123    Chunk, Document, DocumentError, DocumentLoader, DocumentMetadata, IngestionPipeline,
124    SplitterConfig, TextLoader, TextSplitter,
125};
126pub use embedding_registry::{
127    EmbedFuture, Embeddable, EmbeddingRegistry, EmbeddingRegistryError, SyncStats,
128};
129pub use embedding_store::ensure_qdrant_collection;
130pub use error::MemoryError;
131pub use eviction::{EbbinghausPolicy, EvictionConfig, EvictionPolicy, start_eviction_loop};
132pub use facade::{
133    CompactionContext, CompactionResult, InMemoryFacade, MemoryEntry, MemoryFacade, MemoryMatch,
134    MemorySource,
135};
136pub use forgetting::{ForgettingConfig, ForgettingResult, start_forgetting_loop};
137pub use graph::EntityLockManager;
138pub use graph::{
139    BeliefRevisionConfig, Community, Edge, EdgeType, Entity, EntityType, GraphFact, GraphStore,
140    RpeRouter, RpeSignal, extract_candidate_entities,
141};
142pub use qdrant_ops::QdrantOps;
143pub use response_cache::ResponseCache;
144pub use router::{
145    AsyncMemoryRouter, HeuristicRouter, HybridRouter, LlmRouter, MemoryRoute, MemoryRouter,
146    RoutingDecision, TemporalRange, classify_graph_subgraph, parse_route_str,
147    strip_temporal_keywords,
148};
149pub use scenes::{
150    MemScene, SceneConfig, consolidate_scenes, list_scenes, start_scene_consolidation_loop,
151};
152pub use semantic::{
153    BufferedWrite, EmbedContext, ExtractionResult, ExtractionStats, GraphExtractionConfig,
154    LinkingStats, NoteLinkingConfig, PersonaExtractionConfig, StructuredSummary, TrajectoryEntry,
155    TrajectoryExtractionConfig, TreeConsolidationConfig, TreeConsolidationResult, WriteBuffer,
156    build_summarization_prompt, contains_self_referential_language, extract_and_store,
157    extract_persona_facts, extract_trajectory_entries, link_memory_notes,
158    run_tree_consolidation_sweep, start_tree_consolidation_loop,
159};
160pub use snapshot::{ImportStats, MemorySnapshot, export_snapshot, import_snapshot};
161pub use store::compression_guidelines::CompressionFailurePair;
162pub use store::corrections::UserCorrectionRow;
163pub use store::experiments::{ExperimentResultRow, NewExperimentResult, SessionSummaryRow};
164pub use store::memory_tree::MemoryTreeRow;
165pub use store::persona::PersonaFactRow;
166pub use store::session_digest::SessionDigest;
167pub use store::trajectory::{NewTrajectoryEntry, TrajectoryEntryRow};
168pub use tiers::{TierPromotionConfig, start_tier_promotion_loop};
169pub use token_counter::TokenCounter;
170pub use tokio_util::sync::CancellationToken;
171pub use types::{ConversationId, MemSceneId, MemoryTier, MessageId};
172pub use vector_store::{
173    FieldCondition, FieldValue, ScoredVectorPoint, VectorFilter, VectorPoint, VectorStore,
174    VectorStoreError,
175};
zeph_memory/lib.rs

zeph_memory/
lib.rs
