Enum VectorIndexKind 

pub enum VectorIndexKind {
    Flat,
    HnswSquaredEuclidean,
    HnswCosine,
    HnswNegativeInnerProduct,
    IvfSquaredEuclidean,
    IvfCosine,
    IvfNegativeInnerProduct,
    TurboQuantCosine,
}

Vector index algorithm kind.

Variants

Flat

Exact row-set index over full-precision vectors stored on graph rows.

HnswSquaredEuclidean

Approximate HNSW index using squared Euclidean distance.

HnswCosine

Approximate HNSW index using cosine distance.

HnswNegativeInnerProduct

Approximate HNSW index using negative inner product distance.

IvfSquaredEuclidean

Approximate IVF index using squared Euclidean distance.

IvfCosine

Approximate IVF index using cosine distance.

IvfNegativeInnerProduct

Approximate IVF index using negative inner product distance.

TurboQuantCosine

Compressed TurboQuant candidate index using cosine distance.

Implementations

impl VectorIndexKind

pub const fn hnsw_metric(self) -> Option<VectorMetric>

Return the HNSW metric for approximate vector-index kinds.

pub const fn ivf_metric(self) -> Option<VectorMetric>

Return the IVF metric for inverted-file vector-index kinds.

pub const fn ann_metric(self) -> Option<VectorMetric>

Return the ANN metric for approximate vector-index kinds.

Trait Implementations

impl Archive for VectorIndexKind

type Archived = ArchivedVectorIndexKind

The archived representation of this type.

type Resolver = VectorIndexKindResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve( &self, resolver: <Self as Archive>::Resolver, out: Place<<Self as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl Clone for VectorIndexKind

fn clone(&self) -> VectorIndexKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VectorIndexKind

impl Debug for VectorIndexKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorIndexKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<VectorIndexKind, __D> for Archived<VectorIndexKind>

fn deserialize( &self, deserializer: &mut __D, ) -> Result<VectorIndexKind, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Eq for VectorIndexKind

impl Hash for VectorIndexKind

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 PartialEq for VectorIndexKind

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S: Fallible + ?Sized> Serialize<__S> for VectorIndexKind

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl StructuralPartialEq for VectorIndexKind