Struct HnswConfigDiffBuilder

pub struct HnswConfigDiffBuilder { /* private fields */ }

Builder for HnswConfigDiff.

Implementations

impl HnswConfigDiffBuilder

pub fn m(self, value: u64) -> Self

Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.

pub fn ef_construct(self, value: u64) -> Self

Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.

pub fn full_scan_threshold(self, value: u64) -> Self

Minimal size (in KiloBytes) of vectors for additional payload-based indexing. If the payload chunk is smaller than full_scan_threshold additional indexing won’t be used - in this case full-scan search should be preferred by query planner and additional indexing is not required. Note: 1 Kb = 1 vector of size 256

pub fn max_indexing_threads(self, value: u64) -> Self

Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of building broken/inefficient HNSW graphs. On small CPUs, less threads are used.

pub fn on_disk(self, value: bool) -> Self

Store HNSW index on disk. If set to false, the index will be stored in RAM.

pub fn payload_m(self, value: u64) -> Self

Number of additional payload-aware links per node in the index graph. If not set - regular M parameter will be used.

impl HnswConfigDiffBuilder

pub fn build(self) -> HnswConfigDiff

Builds the desired type. Can often be omitted.

Trait Implementations

impl Default for HnswConfigDiffBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<HnswConfigDiffBuilder> for HnswConfigDiff

fn from(value: HnswConfigDiffBuilder) -> Self

Converts to this type from the input type.