Package com.datastax.astra.client.model

Enum SimilarityMetric

java.lang.Object

java.lang.Enum<SimilarityMetric>

com.datastax.astra.client.model.SimilarityMetric

All Implemented Interfaces:

Serializable, Comparable<SimilarityMetric>, java.lang.constant.Constable

public enum SimilarityMetric
extends Enum<SimilarityMetric>

Similarity metric.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COSINE	Distance with cosine.
DOT_PRODUCT	Distance with dot+product (L1).
EUCLIDEAN	Distance with Euclidean (L2).

Method Summary

Modifier and Type	Method	Description
static SimilarityMetric	fromValue(String value)	Build from the key.
static SimilarityMetric	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SimilarityMetric[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COSINE

public static final SimilarityMetric COSINE

Distance with cosine.

EUCLIDEAN

public static final SimilarityMetric EUCLIDEAN

Distance with Euclidean (L2).

DOT_PRODUCT

public static final SimilarityMetric DOT_PRODUCT

Distance with dot+product (L1).

Method Details

values

public static SimilarityMetric[] values()

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

Returns:

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

valueOf

public static SimilarityMetric valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

fromValue

public static SimilarityMetric fromValue(String value)

Build from the key.

Parameters:

value - similarity value

Returns:

similarity enum