Module: Turbopuffer::Models::DistanceMetric

Extended by:

Internal::Type::Enum

Defined in:

lib/turbopuffer/models/distance_metric.rb,
sig/turbopuffer/models/distance_metric.rbs

Overview

A function used to calculate vector similarity.

Constant Summary

COSINE_DISTANCE =

Defined as 1 - cosine_similarity and ranges from 0 to 2. Lower is better.

Returns:

• (:cosine_distance)

:cosine_distance

EUCLIDEAN_SQUARED =

Defined as sum((x - y)^2). Lower is better.

Returns:

• (:euclidean_squared)

:euclidean_squared

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #self?.values ⇒ ::Array[Turbopuffer::Models::distance_metric]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/turbopuffer/models/distance_metric.rb', line 15

Instance Method Details

#self?.values ⇒ ::Array[Turbopuffer::Models::distance_metric]

Returns:

• (::Array[Turbopuffer::Models::distance_metric])

# File 'sig/turbopuffer/models/distance_metric.rbs', line 14

def self?.values: -> ::Array[Turbopuffer::Models::distance_metric]