Struct IvfIndexConfig 

pub struct IvfIndexConfig {

    pub dimension: usize,
    pub loading_mode: IndexLoadingMode,
    pub distance_metric: DistanceMetric,
    pub normalize_vectors: bool,
    pub n_clusters: usize,
    pub n_probe: usize,
    pub max_vectors_per_segment: u64,
    pub write_buffer_size: usize,
    pub use_quantization: bool,
    pub quantization_method: QuantizationMethod,
    pub merge_factor: u32,
    pub max_segments: u32,
    pub embedder: Arc<dyn Embedder>,
}

Configuration specific to IVF index.

These settings control the behavior of the IVF (Inverted File) index implementation, including clustering parameters and storage options.

Fields

dimension: usize

Vector dimension.

loading_mode: IndexLoadingMode

Index loading mode.

distance_metric: DistanceMetric

Distance metric to use.

normalize_vectors: bool

Whether to normalize vectors.

n_clusters: usize

Number of clusters for IVF.

Higher values improve search quality but increase memory usage and construction time.

n_probe: usize

Number of clusters to probe during search.

Higher values improve recall but increase search time.

max_vectors_per_segment: u64

Maximum number of vectors per segment.

write_buffer_size: usize

Buffer size for writing operations (in bytes).

use_quantization: bool

Whether to use quantization.

quantization_method: QuantizationMethod

Quantization method.

merge_factor: u32

Merge factor for segment merging.

max_segments: u32

Maximum number of segments before merging.

embedder: Arc<dyn Embedder>

Embedder for converting text/images to vectors.

This embedder is used when documents contain text or image fields that need to be converted to vector representations. For field-specific embedders, use PerFieldEmbedder.

Trait Implementations

impl Clone for IvfIndexConfig

fn clone(&self) -> IvfIndexConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IvfIndexConfig

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

Formats the value using the given formatter.

impl Default for IvfIndexConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IvfIndexConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IvfIndexConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.