Package com.azure.cosmos.models

Enum CosmosVectorDistanceFunction

java.lang.Object

java.lang.Enum<CosmosVectorDistanceFunction>

com.azure.cosmos.models.CosmosVectorDistanceFunction

All Implemented Interfaces:

Serializable, Comparable<CosmosVectorDistanceFunction>, java.lang.constant.Constable

public enum CosmosVectorDistanceFunction
extends Enum<CosmosVectorDistanceFunction>

Distance Function for the embeddings in the Cosmos DB database service.

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	Represents the cosine distance function.
DOT_PRODUCT	Represents the dot product distance function.
EUCLIDEAN	Represents the euclidean distance function.

Method Summary

Modifier and Type	Method	Description
static CosmosVectorDistanceFunction	fromString(String value)	Method to retrieve the enum constant by its overWireValue.
String	toString()
static CosmosVectorDistanceFunction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CosmosVectorDistanceFunction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EUCLIDEAN

public static final CosmosVectorDistanceFunction EUCLIDEAN

Represents the euclidean distance function.

COSINE

public static final CosmosVectorDistanceFunction COSINE

Represents the cosine distance function.

DOT_PRODUCT

public static final CosmosVectorDistanceFunction DOT_PRODUCT

Represents the dot product distance function.

Method Details

values

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

public static CosmosVectorDistanceFunction valueOf(String name)

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 name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<CosmosVectorDistanceFunction>

fromString

public static CosmosVectorDistanceFunction fromString(String value)

Method to retrieve the enum constant by its overWireValue.

Parameters:

value - the overWire value of the enum constant

Returns:

the matching CosmosVectorDataType

Throws:

IllegalArgumentException - if no matching enum constant is found