Enum VectorIndexType 

#[repr(i32)]
pub enum VectorIndexType {
    VectorIndexHnsw = 0,
    VectorIndexPqHnsw = 1,
    VectorIndexSqHnsw = 2,
    VectorIndexIvfPq = 3,
    VectorIndexIvfSq = 4,
    VectorIndexSpfresh = 5,
    VectorIndexSpfreshLsm = 6,
    VectorIndexDiskann = 7,
    VectorIndexMultivector = 8,
}

The type of vector index — determines quantization / structure.

Variants

VectorIndexHnsw = 0

Plain HNSW (exact distances)

VectorIndexPqHnsw = 1

PQ-accelerated HNSW

VectorIndexSqHnsw = 2

SQ8-accelerated HNSW

VectorIndexIvfPq = 3

IVF with PQ fine quantization

VectorIndexIvfSq = 4

IVF with SQ8 fine quantization

VectorIndexSpfresh = 5

SPFresh IVF-PQ with LIRE incremental rebalancing

VectorIndexSpfreshLsm = 6

DEPRECATED/RETIRED: route to a graph SpFresh index; create returns FailedPrecondition

VectorIndexDiskann = 7

DiskANN/Vamana SSD-resident graph (PQ in RAM, vectors+graph on SSD)

VectorIndexMultivector = 8

ColBERT-style late-interaction multi-vector index

Implementations

impl VectorIndexType

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of VectorIndexType.

pub fn from_i32(value: i32) -> Option<VectorIndexType>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a VectorIndexType, or None if value is not a valid variant.

impl VectorIndexType

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for VectorIndexType

fn clone(&self) -> VectorIndexType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VectorIndexType

impl Debug for VectorIndexType

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

Formats the value using the given formatter.

impl Default for VectorIndexType

fn default() -> VectorIndexType

Returns the “default value” for a type.

impl Eq for VectorIndexType

impl From<VectorIndexType> for i32

fn from(value: VectorIndexType) -> i32

Converts to this type from the input type.

impl Hash for VectorIndexType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VectorIndexType

fn cmp(&self, other: &VectorIndexType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VectorIndexType

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VectorIndexType

fn partial_cmp(&self, other: &VectorIndexType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for VectorIndexType

impl TryFrom<i32> for VectorIndexType

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<VectorIndexType, UnknownEnumValue>

Performs the conversion.