Struct IvfIndex 

pub struct IvfIndex { /* private fields */ }

IVF index for approximate nearest neighbor search

Implementations

impl IvfIndex

pub fn new(config: IvfConfig) -> Result<Self>

Create a new IVF index

pub fn new_with_product_quantization( n_clusters: usize, n_probes: usize, pq_config: PQConfig, ) -> Result<Self>

Create a new IVF index with product quantization

pub fn new_with_multi_level_quantization( n_clusters: usize, n_probes: usize, levels: usize, pq_configs: Vec<PQConfig>, ) -> Result<Self>

Create a new IVF index with multi-level residual quantization

pub fn new_with_multi_codebook_quantization( n_clusters: usize, n_probes: usize, num_codebooks: usize, pq_configs: Vec<PQConfig>, ) -> Result<Self>

Create a new IVF index with multi-codebook quantization

pub fn new_with_residual_quantization( n_clusters: usize, n_probes: usize, pq_config: PQConfig, ) -> Result<Self>

Create a new IVF index with residual quantization enabled (deprecated)

pub fn config(&self) -> &IvfConfig

Get the configuration of this index

pub fn train(&mut self, training_vectors: &[Vector]) -> Result<()>

Train the index with a sample of vectors

pub fn stats(&self) -> IvfStats

Get comprehensive statistics about the IVF index including compression info

Trait Implementations

impl VectorIndex for IvfIndex

fn insert(&mut self, uri: String, vector: Vector) -> Result<()>

Insert a vector with associated URI

fn search_knn(&self, query: &Vector, k: usize) -> Result<Vec<(String, f32)>>

Find k nearest neighbors

fn search_threshold( &self, query: &Vector, threshold: f32, ) -> Result<Vec<(String, f32)>>

Find all vectors within threshold similarity

fn get_vector(&self, _uri: &str) -> Option<&Vector>

Get a vector by its URI

fn add_vector( &mut self, id: VectorId, vector: Vector, _metadata: Option<HashMap<String, String>>, ) -> Result<()>

Add a vector with associated ID and metadata

fn update_vector(&mut self, id: VectorId, vector: Vector) -> Result<()>

Update an existing vector

fn update_metadata( &mut self, _id: VectorId, _metadata: HashMap<String, String>, ) -> Result<()>

Update metadata for a vector

fn remove_vector(&mut self, _id: VectorId) -> Result<()>

Remove a vector by its ID