Struct IndexSchema

pub struct IndexSchema {
    pub index_name: String,
    pub index_type: Option<IndexType>,
    pub metric_type: Option<MetricType>,
    pub params: Option<VectorIndexParams>,
    pub field: String,
    pub auto_build: bool,
    pub state: Option<IndexState>,
    pub auto_build_policy: Option<AutoBuildPolicy>,
    pub index_major_version: Option<u64>,
}

index param

Fields

index_name: String

index_type: Option<IndexType>

The currently supported types are as follows: scalar index: SECONDARY, vector index: HNSW, FLAT

metric_type: Option<MetricType>

Distance measurement type of vector index, L2: Euclidean distance, IP: Inner product distance, COSINE: Cosine distance.

params: Option<VectorIndexParams>

Parameter details of vector index

field: String

The target field name that the index acts on

auto_build: bool

is auto build index

state: Option<IndexState>

index state, this is not param in create index api, but response from server

auto_build_policy: Option<AutoBuildPolicy>

index_major_version: Option<u64>

index major version: only increase when manually rebuilding the index is completed, this is not param in create index api, but response from server

Trait Implementations

impl Clone for IndexSchema

fn clone(&self) -> IndexSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IndexSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.