Package com.datastax.astra.client.model
Enum SimilarityMetric
- All Implemented Interfaces:
Serializable
,Comparable<SimilarityMetric>
,java.lang.constant.Constable
Similarity metric.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionDistance with cosine.Distance with dot+product (L1).Distance with Euclidean (L2). -
Method Summary
Modifier and TypeMethodDescriptionstatic SimilarityMetric
Build from the key.static SimilarityMetric
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.
-
Enum Constant Details
-
COSINE
Distance with cosine. -
EUCLIDEAN
Distance with Euclidean (L2). -
DOT_PRODUCT
Distance with dot+product (L1).
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
fromValue
Build from the key.- Parameters:
value
- similarity value- Returns:
- similarity enum
-