Struct HnswIndexConfig 

pub struct HnswIndexConfig {
    pub m: usize,
    pub ef_construct: usize,
    pub full_scan_threshold: usize,
    pub max_indexing_threads: usize,
    pub on_disk: Option<bool>,
    pub payload_m: Option<usize>,
    pub inline_storage: Option<bool>,
}

Config of HNSW index

Fields

m: usize

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

ef_construct: usize

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

full_scan_threshold: usize

Minimal size threshold (in KiloBytes) below which full-scan is preferred over HNSW search. This measures the total size of vectors being queried against. When the maximum estimated amount of points that a condition satisfies is smaller than full_scan_threshold_kb, the query planner will use full-scan search instead of HNSW index traversal for better performance. Note: 1Kb = 1 vector of size 256

max_indexing_threads: usize

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 slow building or broken/inefficient HNSW graphs. On small CPUs, less threads are used.

on_disk: Option<bool>

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

payload_m: Option<usize>

Custom M param for hnsw graph built for payload index. If not set, default M will be used.

inline_storage: Option<bool>

Store copies of original and quantized vectors within the HNSW index file. Default: false. Enabling this option will trade the search speed for disk usage by reducing amount of random seeks during the search. Requires quantized vectors to be enabled. Multi-vectors are not supported.

Implementations

impl HnswConfig

pub fn mismatch_requires_rebuild(&self, other: &Self) -> bool

Detect configuration mismatch against other that requires rebuilding

Returns true only if both conditions are met:

• this configuration does not match other
• to effectively change the configuration, a HNSW rebuild is required

For example, a change in max_indexing_threads will not require rebuilding because it doesn’t affect the final index, and thus this would return false.

Trait Implementations

impl Clone for HnswConfig

fn clone(&self) -> HnswConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HnswConfig

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

Formats the value using the given formatter.

impl Default for HnswConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HnswConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HnswConfig

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for HnswConfig

fn eq(&self, other: &HnswConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HnswConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for HnswConfig

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for HnswConfig

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl Copy for HnswConfig

impl Eq for HnswConfig

impl StructuralPartialEq for HnswConfig