DistanceFunction Enum

Package:
com.microsoft.semantickernel.data.vectorstorage.definition
Maven Artifact:
com.microsoft.semantic-kernel:semantickernel-api:1.4.0
  • java.lang.Object
    • java.lang.Enum
      • com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction

public enum DistanceFunction
extends java.lang.Enum<DistanceFunction>

Distance functions for vector storage.

Fields

COSINE_DISTANCE

Cosine distance function.
COSINE_SIMILARITY

Cosine (angular) similarity function.
DOT_PRODUCT

Dot product between two vectors.
EUCLIDEAN_DISTANCE

Euclidean distance function.
UNDEFINED

No distance function specified.

Methods inherited from java.lang.Enum

java.lang.Enum.<T>valueOf java.lang.Enum.clone java.lang.Enum.compareTo java.lang.Enum.equals java.lang.Enum.finalize java.lang.Enum.getDeclaringClass java.lang.Enum.hashCode java.lang.Enum.name java.lang.Enum.ordinal java.lang.Enum.toString

Methods inherited from java.lang.Object

java.lang.Object.getClass java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Methods

getValue()

public String getValue()

Gets the function name.

Returns

java.lang.String
The function name.

valueOf(String name)

public static DistanceFunction valueOf(String name)

Parameters

name
java.lang.String

Returns

DistanceFunction

values()

public static DistanceFunction[] values()

Returns

DistanceFunction[]

Applies to