Package dev.langchain4j.community.store.embedding.alloydb.index

Enum Class DistanceStrategy

java.lang.Object

java.lang.Enum<DistanceStrategy>

dev.langchain4j.community.store.embedding.alloydb.index.DistanceStrategy

All Implemented Interfaces:

Serializable, Comparable<DistanceStrategy>, Constable

public enum DistanceStrategy
extends Enum<DistanceStrategy>

Distance strategy for vector

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	Cosine distance options
EUCLIDEAN	Euclidean distance options
INNER_PRODUCT	Inner product startegy options

Method Summary

Modifier and Type	Method	Description
String	getIndexFunction()	get index function
String	getOperator()	get operator
String	getScannIndexFunction()	get ScaNN index function
String	getSearchFunction()	search function
static DistanceStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DistanceStrategy[]	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

EUCLIDEAN

public static final DistanceStrategy EUCLIDEAN

Euclidean distance options

COSINE_DISTANCE

public static final DistanceStrategy COSINE_DISTANCE

Cosine distance options

INNER_PRODUCT

public static final DistanceStrategy INNER_PRODUCT

Inner product startegy options

Method Details

values

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

getOperator

public String getOperator()

get operator

Returns:

DistanceStrategy's operator

getSearchFunction

public String getSearchFunction()

search function

Returns:

DistanceStrategy's search function

getIndexFunction

public String getIndexFunction()

get index function

Returns:

DistanceStrategy's index function

getScannIndexFunction

public String getScannIndexFunction()

get ScaNN index function

Returns:

DistanceStrategy's ScaNN index function