Skip to main content

MemoryStore

Struct MemoryStore 

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

In-memory VectorStore with cosine similarity and BM25 keyword search.

Implementations§

Source§

impl MemoryStore

Source

pub fn open(path: impl Into<PathBuf>) -> Result<Self, RagError>

Open a store backed by path: existing content is loaded, and every change is written back (see the module docs for the guarantees).

Source

pub fn set_autosave(&self, autosave: bool)

Write after every change (default true). With autosave off, changes stay in memory until MemoryStore::flush.

Source

pub fn flush(&self) -> Result<(), RagError>

Write pending changes to the backing file (no-op for in-memory stores).

Source

pub fn save_to(&self, path: &Path) -> Result<(), RagError>

Write the whole store to path (temp file + fsync + rename).

Source§

impl MemoryStore

Source

pub fn new() -> Self

Source

pub fn len(&self) -> usize

Number of chunks across all datasets (0 if the store is unusable after a panic).

Source

pub fn is_empty(&self) -> bool

Source

pub fn chunks(&self) -> Result<Vec<StoredChunk>, RagError>

All stored chunks (for export / inspection).

Trait Implementations§

Source§

impl Clone for MemoryStore

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MemoryStore

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for MemoryStore

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl VectorStore for MemoryStore

Source§

fn upsert( &self, chunks: Vec<StoredChunk>, ) -> BoxFuture<'_, Result<(), RagError>>

Insert or replace chunks (by id).
Source§

fn delete_document<'a>( &'a self, dataset_id: &'a str, document_id: &'a str, ) -> BoxFuture<'a, Result<usize, RagError>>

Remove every chunk of a document. Returns the number removed when known.
Source§

fn delete_dataset<'a>( &'a self, dataset_id: &'a str, ) -> BoxFuture<'a, Result<usize, RagError>>

Remove every chunk of a dataset.
Source§

fn document_chunks<'a>( &'a self, dataset_id: &'a str, document_id: &'a str, ) -> BoxFuture<'a, Result<Vec<StoredChunk>, RagError>>

Every chunk of one document, vectors included. The ingestor uses this to re-ingest a document without re-embedding unchanged chunks and to find the chunks a new version no longer contains.
Source§

fn delete_chunks<'a>( &'a self, dataset_id: &'a str, ids: &'a [String], ) -> BoxFuture<'a, Result<usize, RagError>>

Remove chunks by id. Returns the number removed when known.
Source§

fn search<'a>( &'a self, query: VectorQuery<'a>, ) -> BoxFuture<'a, Result<Vec<Hit>, RagError>>

Nearest neighbours by cosine similarity, best first.
Source§

fn supports_keyword(&self) -> bool

Whether VectorStore::keyword_search is implemented.
Keyword (BM25) search, best first. Stores without a keyword index return nothing.
Source§

fn contains_hash<'a>( &'a self, dataset_id: &'a str, content_hash: &'a str, ) -> BoxFuture<'a, Result<bool, RagError>>

Whether a chunk with this content hash already exists in the dataset. Stores that cannot answer cheaply return false. The built-in crate::Ingestor does not use this (it de-duplicates per document via VectorStore::document_chunks).

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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