VectorSpaceService

Struct VectorSpaceService 

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

The main service for vector space operations.

This service provides a thread-safe interface for:

  • Adding and removing embeddings
  • Nearest neighbor search
  • Building similarity graphs

Implementations§

Source§

impl VectorSpaceService

Source

pub fn new(config: HnswConfig) -> Self

Create a new vector space service with the given configuration.

Source

pub fn from_index(index: HnswIndex, config: HnswConfig) -> Self

Create a service from an existing index.

Source

pub fn dimensions(&self) -> usize

Get the index dimensions.

Source

pub fn len(&self) -> usize

Get the current number of vectors.

Source

pub fn is_empty(&self) -> bool

Check if the index is empty.

Source

pub fn config(&self) -> &HnswConfig

Get a reference to the configuration.

Source

pub async fn add_embedding( &self, id: EmbeddingId, vector: Vec<f32>, ) -> Result<(), VectorError>

Add a single embedding to the index.

The vector will be normalized if the configuration specifies normalization.

Source

pub async fn add_embeddings_batch( &self, items: Vec<(EmbeddingId, Vec<f32>)>, ) -> Result<usize, VectorError>

Add multiple embeddings in a batch.

This is more efficient than multiple single adds due to amortized locking overhead.

Source

pub async fn find_neighbors( &self, query: &[f32], k: usize, ) -> Result<Vec<Neighbor>, VectorError>

Find the k nearest neighbors to a query vector.

Source

pub async fn find_neighbors_with_options( &self, query: &[f32], options: SearchOptions, ) -> Result<Vec<Neighbor>, VectorError>

Find neighbors with custom search options.

Source

pub async fn find_neighbors_with_filter<F>( &self, query: &[f32], k: usize, filter: F, ) -> Result<Vec<Neighbor>, VectorError>
where F: Fn(&EmbeddingId) -> bool + Send + Sync,

Find neighbors using a filter predicate.

The filter function receives an EmbeddingId and returns true if the embedding should be included in results.

Source

pub async fn remove_embedding( &self, id: &EmbeddingId, ) -> Result<(), VectorError>

Remove an embedding from the index.

Source

pub fn contains(&self, id: &EmbeddingId) -> bool

Check if an embedding exists in the index.

Source

pub fn get_vector(&self, id: &EmbeddingId) -> Option<Vec<f32>>

Get a vector by its ID.

Source

pub async fn build_similarity_edges( &self, id: EmbeddingId, vector: &[f32], k: usize, min_similarity: f32, ) -> Result<Vec<SimilarityEdge>, VectorError>

Build similarity edges for an embedding.

This finds the k nearest neighbors and creates edges to them.

Source

pub async fn compute_pairwise_similarities( &self, vectors: &[(EmbeddingId, Vec<f32>)], ) -> Result<Vec<(EmbeddingId, EmbeddingId, f32)>, VectorError>

Compute pairwise similarities for a set of embeddings.

Source

pub async fn clear(&self) -> Result<(), VectorError>

Clear all embeddings from the index.

Source

pub async fn save(&self, path: &Path) -> Result<(), VectorError>

Save the index to a file.

Source

pub async fn load(path: &Path, config: HnswConfig) -> Result<Self, VectorError>

Load an index from a file.

Source

pub fn stats(&self) -> IndexStatistics

Get index statistics.

Trait Implementations§

Source§

impl Clone for VectorSpaceService

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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