Package com.google.genkit.plugins.firebase.retriever

Enum Class FirestoreRetrieverConfig.DistanceMeasure

java.lang.Object

java.lang.Enum<FirestoreRetrieverConfig.DistanceMeasure>

com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.DistanceMeasure

All Implemented Interfaces:

Serializable, Comparable<FirestoreRetrieverConfig.DistanceMeasure>, Constable

Enclosing class:

FirestoreRetrieverConfig

public static enum FirestoreRetrieverConfig.DistanceMeasure
extends Enum<FirestoreRetrieverConfig.DistanceMeasure>

Distance measure options for vector similarity search.

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	Cosine similarity (default).
DOT_PRODUCT	Dot product.
EUCLIDEAN	Euclidean distance.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, 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 FirestoreRetrieverConfig.DistanceMeasure COSINE

Cosine similarity (default).

EUCLIDEAN

public static final FirestoreRetrieverConfig.DistanceMeasure EUCLIDEAN

Euclidean distance.

DOT_PRODUCT

public static final FirestoreRetrieverConfig.DistanceMeasure DOT_PRODUCT

Dot product.

Method Details

values

public static FirestoreRetrieverConfig.DistanceMeasure[] 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 FirestoreRetrieverConfig.DistanceMeasure 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