pub trait Store: Send + Sync {
Show 25 methods
// Required methods
fn store_memory(&self, memory: &Memory) -> Result<()>;
fn get_memory(&self, id: Uuid) -> Result<Option<Memory>>;
fn get_memory_with_embedding(&self, id: Uuid) -> Result<Option<Memory>>;
fn delete_memory(&self, id: Uuid) -> Result<()>;
fn store_entity(&self, entity: &Entity) -> Result<()>;
fn get_entity(&self, id: Uuid) -> Result<Option<Entity>>;
fn find_entity_by_name(&self, name: &str) -> Result<Option<Entity>>;
fn store_conversation(&self, conversation: &Conversation) -> Result<()>;
fn store_relation(&self, relation: &Relation) -> Result<()>;
fn get_relations(
&self,
node_id: Uuid,
relation_type: Option<RelationType>,
) -> Result<Vec<Relation>>;
fn vector_search(
&self,
embedding: &[f32],
limit: usize,
) -> Result<Vec<(Memory, f32)>>;
fn filtered_vector_search(
&self,
embedding: &[f32],
source: Option<&str>,
memory_type: Option<MemoryType>,
project_path: Option<&str>,
limit: usize,
) -> Result<Vec<(Memory, f32)>>;
fn traverse(
&self,
start_id: Uuid,
depth: u32,
) -> Result<Vec<(Memory, Vec<Relation>)>>;
fn memories_by_source(&self, source: &str) -> Result<Vec<Memory>>;
fn memories_by_type(&self, memory_type: MemoryType) -> Result<Vec<Memory>>;
fn update_memory(&self, memory: &Memory) -> Result<()>;
fn record_access(&self, memory: &Memory) -> Result<()>;
fn bm25_search(&self, query: &str, limit: usize) -> Result<Vec<Memory>>;
fn memory_count(&self) -> Result<usize>;
fn all_memory_ids(&self) -> Result<Vec<Uuid>>;
fn all_relations(&self) -> Result<Vec<Relation>>;
// Provided methods
fn remove_memory(&self, id: Uuid) -> Result<bool> { ... }
fn source_admits(&self, memory: &Memory, source: &str) -> Result<bool> { ... }
fn chunk_window(
&self,
memory_id: Uuid,
ord: usize,
) -> Result<Option<String>> { ... }
fn record_accesses(&self, ids: &[Uuid]) -> Result<()> { ... }
}Required Methods§
fn store_memory(&self, memory: &Memory) -> Result<()>
fn get_memory(&self, id: Uuid) -> Result<Option<Memory>>
fn get_memory_with_embedding(&self, id: Uuid) -> Result<Option<Memory>>
fn delete_memory(&self, id: Uuid) -> Result<()>
fn store_entity(&self, entity: &Entity) -> Result<()>
fn get_entity(&self, id: Uuid) -> Result<Option<Entity>>
fn find_entity_by_name(&self, name: &str) -> Result<Option<Entity>>
fn store_conversation(&self, conversation: &Conversation) -> Result<()>
fn store_relation(&self, relation: &Relation) -> Result<()>
fn get_relations( &self, node_id: Uuid, relation_type: Option<RelationType>, ) -> Result<Vec<Relation>>
fn vector_search( &self, embedding: &[f32], limit: usize, ) -> Result<Vec<(Memory, f32)>>
Sourcefn filtered_vector_search(
&self,
embedding: &[f32],
source: Option<&str>,
memory_type: Option<MemoryType>,
project_path: Option<&str>,
limit: usize,
) -> Result<Vec<(Memory, f32)>>
fn filtered_vector_search( &self, embedding: &[f32], source: Option<&str>, memory_type: Option<MemoryType>, project_path: Option<&str>, limit: usize, ) -> Result<Vec<(Memory, f32)>>
Cosine search restricted to memories matching source, memory_type,
and/or project_path, scanned exhaustively over that subset.
A scoped query cannot be served by post-filtering an unfiltered shortlist, because the shortlist is chosen before the filter is known: a memory that does not place in the global top-k is then unreachable no matter how narrow the filter is. Scoping must constrain generation.
fn traverse( &self, start_id: Uuid, depth: u32, ) -> Result<Vec<(Memory, Vec<Relation>)>>
fn memories_by_source(&self, source: &str) -> Result<Vec<Memory>>
fn memories_by_type(&self, memory_type: MemoryType) -> Result<Vec<Memory>>
fn update_memory(&self, memory: &Memory) -> Result<()>
fn record_access(&self, memory: &Memory) -> Result<()>
fn bm25_search(&self, query: &str, limit: usize) -> Result<Vec<Memory>>
fn memory_count(&self) -> Result<usize>
fn all_memory_ids(&self) -> Result<Vec<Uuid>>
fn all_relations(&self) -> Result<Vec<Relation>>
Provided Methods§
Sourcefn remove_memory(&self, id: Uuid) -> Result<bool>
fn remove_memory(&self, id: Uuid) -> Result<bool>
delete_memory that also reports whether a row was there to remove,
so a forget of an unknown id can be answered as such instead of
silently succeeding.
Sourcefn source_admits(&self, memory: &Memory, source: &str) -> Result<bool>
fn source_admits(&self, memory: &Memory, source: &str) -> Result<bool>
Whether memory answers a recall scoped to source. Consolidation
leaves the raws archived and the distillate tagged ‘consolidation’, so
a store that tracks distillation must let a distillate answer for the
sources of its raws, or a source filter finds nothing once its raws
are consolidated. The default is the plain column comparison for
stores that never consolidate.
Sourcefn chunk_window(&self, memory_id: Uuid, ord: usize) -> Result<Option<String>>
fn chunk_window(&self, memory_id: Uuid, ord: usize) -> Result<Option<String>>
The text around a memory’s chunk ord: that chunk joined with one
neighbour on each side. None for a store that keeps no chunks.
Sourcefn record_accesses(&self, ids: &[Uuid]) -> Result<()>
fn record_accesses(&self, ids: &[Uuid]) -> Result<()>
Count one access on each of ids and stamp them with the current
time; confidence is left alone. A recall touches every result it
returns, so an implementation should batch these into one write
rather than take the writer lock per row. Ids the store does not
hold are ignored.
Dyn Compatibility§
This trait is dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".