Struct IndexParams 

pub struct IndexParams { /* private fields */ }

Parameters for configuring an index on a field.

Implementations

impl IndexParams

pub unsafe fn as_raw(&self) -> *mut zvec_index_params_t

Returns the raw FFI handle.

Safety

The caller must not use the handle after the IndexParams is dropped.

pub fn hnsw(metric: MetricType, m: i32, ef_construction: i32) -> Result<Self>

Creates HNSW index parameters.

pub fn hnsw_with_quantize( metric: MetricType, m: i32, ef_construction: i32, quantize: QuantizeType, ) -> Result<Self>

Creates HNSW index parameters with quantization.

pub fn ivf( metric: MetricType, n_list: i32, n_iters: i32, use_soar: bool, ) -> Result<Self>

Creates IVF index parameters.

pub fn ivf_rabitq( metric: MetricType, nlist: i32, total_bits: i32, sample_count: i32, ) -> Result<Self>

Creates IVF RaBitQ index parameters.

IVF RaBitQ combines inverted-file clustering with RaBitQ quantization for memory-efficient approximate search.

• nlist: number of cluster centers
• total_bits: total bits for RaBitQ quantization
• sample_count: sample count for training; 0 uses all vectors

pub fn flat(metric: MetricType) -> Result<Self>

Creates Flat index parameters.

pub fn diskann( metric: MetricType, max_degree: i32, list_size: i32, pq_chunk_num: i32, ) -> Result<Self>

Creates DiskANN index parameters.

DiskANN is a disk-based graph index that keeps the bulk of the index on disk, drastically reducing memory usage for large datasets.

• max_degree: graph connectivity, i.e. max out-degree of the graph (typical: 64)
• list_size: build-time candidate list size during construction (typical: 100)
• pq_chunk_num: PQ chunk count; 0 disables product quantization

pub fn invert(enable_range_opt: bool, enable_wildcard: bool) -> Result<Self>

Creates inverted index parameters for scalar fields.

pub fn fts( tokenizer_name: Option<&str>, filters: Option<&[&str]>, extra_params: Option<&str>, ) -> Result<Self>

Creates FTS (Full-Text Search) index parameters.

All parameters are optional — passing None keeps the library default.

pub fn index_type(&self) -> IndexType

Returns the index type.

pub fn metric_type(&self) -> MetricType

Returns the metric type.

pub fn quantize_type(&self) -> QuantizeType

Returns the quantize type.

pub fn set_metric_type(&mut self, metric: MetricType) -> Result<()>

Sets the metric type.

pub fn set_quantize_type(&mut self, quantize: QuantizeType) -> Result<()>

Sets the quantize type.

Trait Implementations

impl Drop for IndexParams

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.