Package org.springframework.ai.vectorstore.elasticsearch

Enum Class SimilarityFunction

java.lang.Object

java.lang.Enum<SimilarityFunction>

org.springframework.ai.vectorstore.elasticsearch.SimilarityFunction

All Implemented Interfaces:

Serializable, Comparable<SimilarityFunction>, Constable

public enum SimilarityFunction
extends Enum<SimilarityFunction>

https://www.elastic.co/guide/en/elasticsearch/reference/master/dense-vector.html max_inner_product is currently not supported because the distance value is not normalized and would not comply with the requirement of being between 0 and 1

Since:

1.0.0

Author:

Laura Trotta

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
dot_product
l2_norm

Method Summary

Modifier and Type	Method	Description
static SimilarityFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SimilarityFunction[]	values()	Returns an array containing the constants of this enum class, 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

l2_norm

public static final SimilarityFunction l2_norm

dot_product

public static final SimilarityFunction dot_product

cosine

public static final SimilarityFunction cosine

Method Details

values

public static SimilarityFunction[] 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 SimilarityFunction 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