Skip to main content

HnswIndex

Struct HnswIndex 

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

HNSW vector index backed by usearch.

Implementations§

Source§

impl HnswIndex

Source

pub fn new(config: VectorConfig) -> Result<Self, CodememError>

Create a new HNSW index with the given configuration.

Source

pub fn with_defaults() -> Result<Self, CodememError>

Create a new index with default configuration (768-dim, cosine).

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.

Trait Implementations§

Source§

impl VectorBackend for HnswIndex

Source§

fn insert(&mut self, id: &str, embedding: &[f32]) -> Result<(), CodememError>

Insert a vector with associated ID.
Source§

fn insert_batch( &mut self, items: &[(String, Vec<f32>)], ) -> Result<(), CodememError>

Batch insert vectors.
Source§

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

Search for k nearest neighbors. Returns (id, distance) pairs.
Source§

fn remove(&mut self, id: &str) -> Result<bool, CodememError>

Remove a vector by ID.
Source§

fn save(&self, path: &Path) -> Result<(), CodememError>

Save the index to disk.
Source§

fn load(&mut self, path: &Path) -> Result<(), CodememError>

Load the index from disk.
Source§

fn stats(&self) -> VectorStats

Get index statistics.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.