VectorSearchIndex

Struct VectorSearchIndex 

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

Vector search index

Implementations§

Source§

impl VectorSearchIndex

Source

pub fn new(config: SearchConfig) -> Self

Create new vector search index

Source

pub fn build(&mut self, embeddings: &HashMap<String, Vec<f32>>) -> Result<()>

Build search index from embeddings

Source

pub fn search(&self, query: &[f32], k: usize) -> Result<Vec<SearchResult>>

Search for K nearest neighbors

Batch search for multiple queries

Source

pub fn get_stats(&self) -> IndexStats

Get index statistics

Find entities within a radius

Source

pub fn set_metadata(&mut self, entity_id: &str, metadata: Metadata)

Set metadata for an entity

Source

pub fn set_metadata_batch(&mut self, metadata_map: HashMap<String, Metadata>)

Set metadata for multiple entities

Source

pub fn get_metadata(&self, entity_id: &str) -> Option<&Metadata>

Get metadata for an entity

Search with metadata filtering (post-filtering)

Post-filtering searches all vectors first, then filters results. This is efficient when the filter is selective.

Search with pre-filtering (filter before computing distances)

Pre-filtering only computes distances for entities matching the filter. This is efficient when the filter discards most entities.

Source

pub fn add_vector( &mut self, entity_id: String, embedding: Vec<f32>, ) -> Result<()>

Add a single vector to the index incrementally (without full rebuild)

This is more efficient than rebuilding when adding a few vectors. For bulk additions, consider using add_vectors or build.

Source

pub fn add_vectors( &mut self, embeddings: &HashMap<String, Vec<f32>>, ) -> Result<()>

Add multiple vectors to the index incrementally

More efficient than calling add_vector multiple times.

Source

pub fn remove_vector(&mut self, entity_id: &str) -> Result<()>

Remove a vector from the index

Source

pub fn remove_vectors(&mut self, entity_ids: &[&str]) -> Result<()>

Remove multiple vectors from the index

Source

pub fn update_vector( &mut self, entity_id: &str, new_embedding: Vec<f32>, ) -> Result<()>

Update an existing vector in the index

Source

pub fn clear(&mut self)

Clear all vectors from the index

Source

pub fn len(&self) -> usize

Get the number of vectors in the index

Source

pub fn is_empty(&self) -> bool

Check if the index is empty

Source

pub fn contains(&self, entity_id: &str) -> bool

Check if a vector exists in the index

Source

pub fn get_vector(&self, entity_id: &str) -> Option<&Vec<f32>>

Get a vector from the index

Source

pub fn merge( &mut self, other: &VectorSearchIndex, overwrite_duplicates: bool, ) -> Result<()>

Merge another index into this one

Combines vectors from another index, handling duplicates and dimension checks. By default, duplicates are skipped. Use overwrite_duplicates to update existing vectors.

Source

pub fn merge_multiple( indexes: &[&VectorSearchIndex], ) -> Result<VectorSearchIndex>

Create a new index by merging multiple indexes

This is more efficient than merging sequentially when combining many indexes.

Trait Implementations§

Source§

impl Clone for VectorSearchIndex

Source§

fn clone(&self) -> VectorSearchIndex

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
Source§

impl Debug for VectorSearchIndex

Source§

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

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

impl<'de> Deserialize<'de> for VectorSearchIndex

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for VectorSearchIndex

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,