Struct EdgeConfig 

pub struct EdgeConfig {
    pub on_disk_payload: bool,
    pub vectors: HashMap<String, EdgeVectorParams>,
    pub sparse_vectors: HashMap<String, EdgeSparseVectorParams>,
    pub hnsw_config: HnswConfig,
    pub quantization_config: Option<QuantizationConfig>,
    pub optimizers: EdgeOptimizersConfig,
}

Full configuration for an edge shard.

Fields

on_disk_payload: bool

If true, payload is stored on disk (mmap); otherwise in RAM. Same as CollectionParams::on_disk_payload.

vectors: HashMap<String, EdgeVectorParams>

Dense vector params per vector name.

sparse_vectors: HashMap<String, EdgeSparseVectorParams>

Sparse vector params per vector name.

hnsw_config: HnswConfig

Global HNSW config; per-vector override is in vectors[].hnsw_config

quantization_config: Option<QuantizationConfig>

Global quantization config for all vectors Per-vector override in in vectors[].quantization_config

optimizers: EdgeOptimizersConfig

Implementations

impl EdgeConfig

pub fn from_segment_config(segment: &SegmentConfig) -> Self

Build from existing segment config. Fills all parameters that can be inferred.

pub fn check_compatible_with_segment_config( &self, other: &SegmentConfig, ) -> Result<(), String>

Check compatibility with a segment config (e.g. loaded segment).

pub fn plain_segment_config(&self) -> SegmentConfig

Segment config for creating appendable segments only. Does not contain any HNSW configuration (plain index only).

pub fn segment_optimizer_config(&self) -> SegmentOptimizerConfig

Build segment optimizer config from this config (for blocking optimizers). Use this instead of converting to SegmentConfig first.

pub fn vector_data_config(&self, name: &String) -> Option<VectorDataConfig>

Return vector data config for a named vector (for read-only use, e.g. query). Uses plain index; for optimizer/segment creation use segment_optimizer_config or plain_segment_config.

pub fn optimizer_thresholds( &self, num_indexing_threads: usize, ) -> OptimizerThresholds

pub fn save(&self, path: &Path) -> OperationResult<()>

pub fn load(path: &Path) -> Option<OperationResult<Self>>

pub fn set_hnsw_config(&mut self, hnsw_config: HnswConfig)

pub fn set_vector_hnsw_config( &mut self, vector_name: &str, hnsw_config: HnswConfig, ) -> OperationResult<()>

pub fn set_optimizers_config(&mut self, optimizers: EdgeOptimizersConfig)

pub fn optimizers_mut(&mut self) -> &mut EdgeOptimizersConfig

Trait Implementations

impl Clone for EdgeConfig

fn clone(&self) -> EdgeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EdgeConfig

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

Formats the value using the given formatter.

impl Default for EdgeConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EdgeConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EdgeConfig

fn eq(&self, other: &EdgeConfig) -> 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 EdgeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EdgeConfig