Package com.google.genkit.plugins.mongodb

Enum Class MongoVectorStoreConfig.Similarity

java.lang.Object

java.lang.Enum<MongoVectorStoreConfig.Similarity>

com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Similarity

All Implemented Interfaces:

Serializable, Comparable<MongoVectorStoreConfig.Similarity>, Constable

Enclosing class:

MongoVectorStoreConfig

public static enum MongoVectorStoreConfig.Similarity
extends Enum<MongoVectorStoreConfig.Similarity>

Vector similarity function supported by Atlas Vector 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
DOT_PRODUCT
EUCLIDEAN

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the Atlas Vector Search similarity name.
static MongoVectorStoreConfig.Similarity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MongoVectorStoreConfig.Similarity[]	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 MongoVectorStoreConfig.Similarity COSINE

EUCLIDEAN

public static final MongoVectorStoreConfig.Similarity EUCLIDEAN

DOT_PRODUCT

public static final MongoVectorStoreConfig.Similarity DOT_PRODUCT

Method Details

values

public static MongoVectorStoreConfig.Similarity[] 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 MongoVectorStoreConfig.Similarity 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

getValue

public String getValue()

Returns the Atlas Vector Search similarity name.

Returns:

the similarity name