Struct VectorSchema 

pub struct VectorSchema {
    pub vector_field: String,
    pub vector_type: VectorType,
    pub dim: u16,
    pub distance: DistanceMetric,
    pub algorithm: IndexAlgorithm,
    pub prefixes: Vec<Vec<u8>>,
    pub metadata_fields: Vec<MetadataField>,
}

Compiled FT.CREATE schema.

One VectorSchema describes one index: the vector field, its dimension and codec, the distance metric, the chosen algorithm, the prefix set (FT.CREATE PREFIX <n> ...), and the set of non-vector metadata fields.

Fields

vector_field: String

Name of the document field that carries the vector.

vector_type: VectorType

Codec.

dim: u16

Frozen vector dimension.

distance: DistanceMetric

Distance metric.

algorithm: IndexAlgorithm

Index algorithm.

prefixes: Vec<Vec<u8>>

Document key prefixes (FT.CREATE ... PREFIX <n> <prefix>...). HSET commands whose key starts with any of these prefixes get intercepted and indexed.

metadata_fields: Vec<MetadataField>

Non-vector schema fields.

Implementations

impl VectorSchema

pub fn to_engine_schema(&self, table_name: &str) -> TableSchema

Build the corresponding dynvec::TableSchema for a table named table_name.

Picks default HNSW tuning; future revisions will pull the parameters out of the FT.CREATE clause.

Trait Implementations

impl Clone for VectorSchema

fn clone(&self) -> VectorSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VectorSchema

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VectorSchema

impl StructuralPartialEq for VectorSchema