Share via

CosmosVectorDistanceFunction Enum

Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.76.0
  • java.lang.Object
    • java.lang.Enum
      • com.azure.cosmos.models.CosmosVectorDistanceFunction

public enum CosmosVectorDistanceFunction
extends Enum<CosmosVectorDistanceFunction>

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

Fields

COSINE

Represents the cosine distance function.
DOT_PRODUCT

Represents the dot product distance function.
EUCLIDEAN

Represents the euclidean distance function.

Methods inherited from java.lang.Enum

valueOf clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString

Methods inherited from java.lang.Object

getClass notify notifyAll wait wait wait

Methods

fromString(String value)

public static CosmosVectorDistanceFunction fromString(String value)

Method to retrieve the enum constant by its overWireValue.

Parameters

value
String
the overWire value of the enum constant

Returns

CosmosVectorDistanceFunction
the matching CosmosVectorDataType

toString()

public String toString()

Returns

String
Overrides
java.lang.Enum.toString()

valueOf(String name)

public static CosmosVectorDistanceFunction valueOf(String name)

Parameters

name
String

Returns

CosmosVectorDistanceFunction

values()

public static CosmosVectorDistanceFunction[] values()

Returns

CosmosVectorDistanceFunction[]

Applies to