Enum Class ScoringFunction

java.lang.Object

java.lang.Enum<ScoringFunction>

io.micronaut.data.model.vector.search.ScoringFunction

All Implemented Interfaces:

Serializable, Comparable<ScoringFunction>, Constable

public enum ScoringFunction
extends Enum<ScoringFunction>

Supported vector similarity scoring functions.

Names are intentionally aligned with VectorIndexType.DistanceType to keep index-time and query-time metric selection consistent.

Since:

5.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COSINE	Cosine distance/similarity score function.
DOT	Dot-product (inner-product) score function.
L1_MANHATTAN	L1/Manhattan distance score function.
L2_EUCLIDEAN	L2/Euclidean distance score function.
L2_EUCLIDEAN_SQUARED	Squared L2/Euclidean distance score function.

Method Summary

Modifier and Type	Method	Description
static ScoringFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScoringFunction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COSINE

public static final ScoringFunction COSINE

Cosine distance/similarity score function.

DOT

public static final ScoringFunction DOT

Dot-product (inner-product) score function.

L1_MANHATTAN

public static final ScoringFunction L1_MANHATTAN

L1/Manhattan distance score function.

L2_EUCLIDEAN

public static final ScoringFunction L2_EUCLIDEAN

L2/Euclidean distance score function.

L2_EUCLIDEAN_SQUARED

public static final ScoringFunction L2_EUCLIDEAN_SQUARED

Squared L2/Euclidean distance score function.

Method Details

values

public static ScoringFunction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScoringFunction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null