Package org.springframework.ai.vectorstore

Enum Class PgVectorStore.PgDistanceType

java.lang.Object

java.lang.Enum<PgVectorStore.PgDistanceType>

org.springframework.ai.vectorstore.PgVectorStore.PgDistanceType

All Implemented Interfaces:

Serializable, Comparable<PgVectorStore.PgDistanceType>, Constable

Enclosing class:

PgVectorStore

public static enum PgVectorStore.PgDistanceType
extends Enum<PgVectorStore.PgDistanceType>

Defaults to CosineDistance. But if vectors are normalized to length 1 (like OpenAI embeddings), use inner product (NegativeInnerProduct) for best performance.

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_DISTANCE
EUCLIDEAN_DISTANCE
NEGATIVE_INNER_PRODUCT

Field Summary

Fields

Modifier and Type	Field	Description
final String	index
final String	operator
final String	similaritySearchSqlTemplate

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EUCLIDEAN_DISTANCE

public static final PgVectorStore.PgDistanceType EUCLIDEAN_DISTANCE

NEGATIVE_INNER_PRODUCT

public static final PgVectorStore.PgDistanceType NEGATIVE_INNER_PRODUCT

COSINE_DISTANCE

public static final PgVectorStore.PgDistanceType COSINE_DISTANCE

Field Details

operator

public final String operator

index

public final String index

similaritySearchSqlTemplate

public final String similaritySearchSqlTemplate

Method Details

values

public static PgVectorStore.PgDistanceType[] 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 PgVectorStore.PgDistanceType 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