Skip to main content

klieo_memory_pgvector/
lib.rs

1#![deny(missing_docs)]
2#![deny(rust_2018_idioms)]
3#![deny(rustdoc::broken_intra_doc_links)]
4
5//! PostgreSQL + pgvector implementation of `klieo_core::memory::LongTermMemory`.
6//!
7//! Sibling to `klieo-memory-qdrant`: the same `LongTermMemory` +
8//! `FilterableLongTermMemory` surface over an Aurora PostgreSQL Serverless v2
9//! (or any Postgres with the `vector` extension) instead of Qdrant. Facts live
10//! in one table with a `vector(dim)` column (HNSW, cosine) and `scope_kind` /
11//! `scope_value` filter columns; metadata is stored as `jsonb` so relational
12//! joins to domain keys (Versicherungsnummer, Vertrag, GeVo-Typ) remain
13//! possible against the same table.
14//!
15//! `MemoryPgvector::connect(url)` is the capability-shaped default —
16//! connects, lazily provisions the table on first `remember`, and returns an
17//! `Arc<dyn LongTermMemory>`. Defaults to [`DummyEmbedder`].
18//!
19//! # Quickstart
20//!
21//! ```no_run
22//! use klieo_memory_pgvector::MemoryPgvector;
23//!
24//! async fn example() {
25//!     let mem = MemoryPgvector::connect("postgres://localhost/klieo").await.unwrap();
26//!     let _ = mem.long_term;
27//! }
28//! ```
29//!
30//! # Advanced wiring — custom config + embedder
31//!
32//! ```no_run
33//! use klieo_memory_pgvector::{MemoryPgvector, PgvectorConfig, DummyEmbedder};
34//! use std::sync::Arc;
35//!
36//! async fn example() {
37//!     let cfg = PgvectorConfig::new("postgres://aurora.internal/klieo?sslmode=require")
38//!         .with_table_prefix("triage")
39//!         .with_embedder_id("titan-v2");
40//!     let mem = MemoryPgvector::new(cfg, Arc::new(DummyEmbedder)).await.unwrap();
41//!     let _ = mem.long_term;
42//! }
43//! ```
44//!
45//! # What's implemented
46//!
47//! Only `LongTermMemory` (+ `FilterableLongTermMemory`). `ShortTermMemory` and
48//! `EpisodicMemory` are not vector-shaped — see `klieo-memory-sqlite` /
49//! `klieo-memory-neo4j`.
50
51pub mod embedder;
52pub use embedder::{DummyEmbedder, Embedder};
53
54#[cfg(any(test, feature = "test-utils"))]
55pub use embedder::FakeEmbedder;
56
57pub mod client;
58pub use client::PgvectorConfig;
59
60pub mod error;
61
62pub mod long_term;
63pub use long_term::PgvectorLongTerm;
64
65pub mod factory;
66pub use factory::MemoryPgvector;