Struct EmbeddingStore 

pub struct EmbeddingStore { /* private fields */ }

In-memory store for labelled embedding vectors.

Implementations

impl EmbeddingStore

pub fn new() -> Self

Create an empty EmbeddingStore.

pub fn insert( &mut self, label: impl Into<String>, vector: Vec<f64>, ) -> Result<usize, StoreError>

Insert a new embedding.

All vectors in the store must have the same dimension. The first insertion fixes the dimension for all subsequent insertions.

Returns the assigned id on success.

pub fn insert_with_meta( &mut self, label: impl Into<String>, vector: Vec<f64>, meta: HashMap<String, String>, ) -> Result<usize, StoreError>

Insert a new embedding with accompanying metadata.

pub fn get_by_label(&self, label: &str) -> Option<&EmbeddingEntry>

Look up an entry by its label.

pub fn get_by_id(&self, id: usize) -> Option<&EmbeddingEntry>

Look up an entry by its sequential id.

pub fn cosine_similarity(a: &[f64], b: &[f64]) -> f64

Compute the cosine similarity between two slices of equal length.

Returns 0.0 when either vector has zero norm.

pub fn nearest( &self, query: &[f64], k: usize, ) -> Result<Vec<(&EmbeddingEntry, f64)>, StoreError>

Return the k nearest entries to query by cosine similarity, in descending order of similarity.

Returns StoreError::EmptyStore when the store is empty and StoreError::DimensionMismatch when query has the wrong length.

pub fn len(&self) -> usize

Number of entries currently in the store.

pub fn is_empty(&self) -> bool

true when the store is empty.

pub fn dim(&self) -> Option<usize>

The fixed dimension of all stored vectors, or None if no vectors have been inserted yet.

pub fn labels(&self) -> Vec<&str>

Return a list of all labels in insertion order.

pub fn remove(&mut self, label: &str) -> bool

Remove the entry with the given label.

Returns true if the entry was found and removed, false otherwise.

Note: removing an entry does not reuse or reassign its id.

Trait Implementations

impl Default for EmbeddingStore

fn default() -> Self

Returns the “default value” for a type.