Enum SqliteDistanceMetric 

pub enum SqliteDistanceMetric {
    Cosine,
    L2,
    L1,
}

Distance metric used by SQLite vector searches.

The metric is applied consistently to sqlite-vec candidate search, thresholding, ordering, and returned scores. Returned scores are higher-is-better: SqliteDistanceMetric::Cosine returns cosine similarity (1 - cosine_distance), while SqliteDistanceMetric::L2 and SqliteDistanceMetric::L1 return the negative sqlite-vec distance.

Variants

Cosine

Cosine similarity, returned as 1 - cosine_distance.

L2

Negative sqlite-vec L2 distance.

L1

Negative sqlite-vec L1 distance.

Trait Implementations

impl Clone for SqliteDistanceMetric

fn clone(&self) -> SqliteDistanceMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqliteDistanceMetric

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

Formats the value using the given formatter.

impl Default for SqliteDistanceMetric

fn default() -> SqliteDistanceMetric

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SqliteDistanceMetric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SqliteDistanceMetric

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SqliteDistanceMetric

impl Eq for SqliteDistanceMetric

impl StructuralPartialEq for SqliteDistanceMetric