Struct DenseVectorConfig 

pub struct DenseVectorConfig {
    pub dim: usize,
    pub index_type: VectorIndexType,
    pub store_raw: bool,
    pub coarse_centroids_path: Option<String>,
    pub pq_codebook_path: Option<String>,
    pub nprobe: usize,
    pub mrl_dim: Option<usize>,
}

Configuration for dense vector fields using RaBitQ, IVF-RaBitQ, or ScaNN

Fields

dim: usize

Dimensionality of vectors

index_type: VectorIndexType

Vector index algorithm to use

store_raw: bool

Whether to store raw vectors for re-ranking (increases storage but improves accuracy)

coarse_centroids_path: Option<String>

Path to pre-trained coarse centroids file for IVF indexes Required for IVF-RaBitQ and ScaNN

pq_codebook_path: Option<String>

Path to pre-trained PQ codebook file for ScaNN

nprobe: usize

Number of clusters to probe during search (default: 32)

mrl_dim: Option<usize>

Matryoshka/MRL dimension for index - use only first mrl_dim coordinates for indexing Full vectors are stored but index uses truncated vectors for faster search Must be <= dim. If None, uses full dim.

Implementations

impl DenseVectorConfig

pub fn new(dim: usize) -> Self

pub fn with_ivf(dim: usize, centroids_path: String, nprobe: usize) -> Self

pub fn with_scann( dim: usize, centroids_path: String, codebook_path: String, nprobe: usize, ) -> Self

Create ScaNN configuration with pre-trained centroids and codebook

pub fn without_raw(dim: usize) -> Self

pub fn with_mrl_dim(self, mrl_dim: usize) -> Self

Set matryoshka/MRL dimension for index truncation

pub fn index_dim(&self) -> usize

Get the effective dimension for indexing (mrl_dim if set, otherwise dim)

pub fn uses_ivf(&self) -> bool

Check if this config uses IVF (has coarse centroids)

pub fn uses_scann(&self) -> bool

Check if this config uses ScaNN

Trait Implementations

impl Clone for DenseVectorConfig

fn clone(&self) -> DenseVectorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DenseVectorConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DenseVectorConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DenseVectorConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.