Struct IndexConfig

pub struct IndexConfig {
    pub name: String,
    pub dimension: usize,
    pub metric: SimilarityMetric,
    pub options: HashMap<String, MetadataValue>,
}

Index configuration

Fields

name: String

Index name

dimension: usize

Vector dimension

metric: SimilarityMetric

Similarity metric

options: HashMap<String, MetadataValue>

Optional index-specific configuration

Implementations

impl IndexConfig

pub fn new(name: impl Into<String>, dimension: usize) -> IndexConfig

Create a new index configuration

pub fn with_metric(self, metric: SimilarityMetric) -> IndexConfig

Set the similarity metric

pub fn with_option( self, key: impl Into<String>, value: impl Into<MetadataValue>, ) -> IndexConfig

Add an option

Trait Implementations

impl Clone for IndexConfig

fn clone(&self) -> IndexConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<IndexConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IndexConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.