Struct HnswOption 

pub struct HnswOption {
    pub dimension: usize,
    pub distance: DistanceMetric,
    pub m: usize,
    pub ef_construction: usize,
    pub base_weight: f32,
    pub quantizer: Option<QuantizationMethod>,
    pub embedder: Option<String>,
}

Options for HNSW vector index.

Fields

dimension: usize

Number of dimensions for each vector. Defaults to 128.

distance: DistanceMetric

Distance metric used for similarity computation. Defaults to DistanceMetric::Cosine.

m: usize

Maximum number of bi-directional links per node in the HNSW graph. Higher values improve recall but increase memory usage. Defaults to 16.

ef_construction: usize

Size of the dynamic candidate list during index construction. Higher values produce a higher-quality graph at the cost of slower build times. Defaults to 200.

base_weight: f32

Base weight applied to similarity scores from this field. Defaults to 1.0.

quantizer: Option<QuantizationMethod>

Optional quantization method to reduce memory usage at the cost of some precision.

embedder: Option<String>

Embedder name for this vector field. When set, the engine automatically embeds input using the named embedder.

Implementations

impl HnswOption

pub fn new(dimension: usize) -> Self

pub fn dimension(self, dimension: usize) -> Self

pub fn distance(self, distance: DistanceMetric) -> Self

pub fn m(self, m: usize) -> Self

pub fn ef_construction(self, ef: usize) -> Self

pub fn base_weight(self, weight: f32) -> Self

pub fn quantizer(self, quantizer: QuantizationMethod) -> Self

Trait Implementations

impl Clone for HnswOption

fn clone(&self) -> HnswOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HnswOption

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

Formats the value using the given formatter.

impl Default for HnswOption

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HnswOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<HnswOption> for FieldOption

fn from(opt: HnswOption) -> Self

Converts to this type from the input type.

impl Serialize for HnswOption

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

where __S: Serializer,

Serialize this value into the given Serde serializer.