Skip to main content

RecallEngine

Struct RecallEngine 

Source
pub struct RecallEngine { /* private fields */ }
Expand description

Hybrid recall engine combining BM25 + vector search.

Wraps a MemoryStore, SearchEngine, VectorStore, and Embedder to provide fused search at recall time and auto-embedding at write time.

Implementations§

Source§

impl RecallEngine

Source

pub fn new( store: Arc<MemoryStore>, search_engine: Arc<SearchEngine>, vector_store: VectorStore, embedder: Arc<dyn Embedder>, config: RecallConfig, ) -> Result<Self>

Create a new recall engine.

Returns an error if the Tantivy IndexWriter cannot be created.

Source

pub fn record_relevance_feedback( &self, score: f32, relevant: bool, ) -> Result<usize>

Record one relevance-feedback sample into the conformal calibrator (V8 S8). Errors honestly when the knob is off — there is no calibrated set to feed.

Source

pub fn conformal_disclosure( &self, results: &mut [RecallResult], ) -> Result<Option<ConformalSetInfo>>

Conformal disclosure for a completed search: grades the results against the calibrated set (marking in_conformal_set) and returns the set-level info. Ok(None) when the knob is off — no claim is made at all.

Source

pub fn config(&self) -> &RecallConfig

Get the configuration.

Source

pub fn embedder_is_real(&self) -> bool

Whether the embedder is a real backend (not a stub).

When false, hybrid search would produce garbage vectors and store_with_embedding should be avoided in favor of plain BM25.

Source

pub fn embedder_probe(&self) -> Result<usize>

Probe the configured embedder with one tiny input.

Degradation honesty: a configured embedder that cannot answer (server down, model missing) must not silently downgrade recall. Returns the produced vector length on success.

§Errors

Propagates the embedder’s error (transport, model, dimension).

Source

pub fn store_with_embedding( &self, galaxy: Galaxy, memory: &Memory, ) -> Result<()>

Store a memory with auto-embedding.

  1. Embeds the content using the configured embedder.
  2. Stores the memory in the given galaxy.
  3. Stores the embedding in the Embeddings galaxy.
  4. Adds the embedding to the vector store.
  5. Indexes the content in Tantivy.
Source

pub fn store_batch_with_embedding( &self, entries: &[(Galaxy, &Memory)], ) -> Result<usize>

Batch-store memories with auto-embedding in a single HTTP call + single Tantivy commit.

Like store_with_embedding but for multiple memories at once:

  1. Embeds all content via embed_batch() (single HTTP call).
  2. Stores all memories to LMDB.
  3. Stores all embeddings.
  4. Adds all to the vector store.
  5. Indexes all in Tantivy with a single writer + commit.

Returns the number of memories successfully stored.

Source

pub fn backfill_embeddings( &self, galaxy: Option<Galaxy>, limit: usize, dry_run: bool, ) -> Result<BackfillReport>

Backfill per-memory vectors for memories that have none.

Streams the requested galaxies in LMDB key order and collects up to limit memories lacking a stored embedding (limit == 0 = no cap), then embeds + persists them, also seeding the in-memory vector index. The scan opens its own read transaction and the embed/put writes use their own transactions — no nested LMDB read txns, no full-galaxy materialization (candidate collection is capped by limit). dry_run reports candidates without writing.

§Errors

Fails fast when the wired embedder is the stub (backfill would store noise), matching the embedder_is_real gate used by the write path.

Hybrid search combining BM25 + vector similarity.

Weights: bm25_weight * BM25 + vector_weight * cosine + importance_weight * importance

Source

pub fn hybrid_search_with_disclosure( &self, query: &str, limit: usize, galaxy_filter: Option<Galaxy>, ) -> (Vec<RecallResult>, Option<ConformalSetInfo>)

Hybrid search plus the V8 S8 disclosure: (results, conformal). conformal is None when WM_RECALL_CONFORMAL_ALPHA is unset — no calibrated claim exists, so none is made.

Pure vector search (no BM25).

Pure BM25 search (no vector).

Source

pub fn promote_memory(&self, galaxy: Galaxy, id: Uuid) -> Result<bool>

Promote a memory on recall hit: calls Memory::recall() to apply Hebbian strengthening and updates accessed_at/access_count/recall_count in the store.

Source

pub fn is_private(&self, id: Uuid, galaxy: Galaxy) -> bool

Whether a memory is flagged is_private (missing memories count as private — they cannot be verified visible).

Source

pub fn cache_size(&self) -> usize

Get the number of cached embeddings.

Source

pub fn clear_cache(&self)

Clear the embedding cache.

Source

pub fn vector_count(&self) -> usize

Get the number of vectors in the vector store.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more