Enum Class VectorIndexType

java.lang.Object

java.lang.Enum<VectorIndexType>

io.micronaut.data.annotation.VectorIndexType

All Implemented Interfaces:

Serializable, Comparable<VectorIndexType>, Constable

public enum VectorIndexType
extends Enum<VectorIndexType>

Vector index algorithm type used by supported databases. Implementations may map these values to vendor-specific algorithms.

Since:

5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VectorIndexType.DistanceType	Distance (similarity) metric to use for vector searches.

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HNSW	Hierarchical Navigable Small World graph index.
IVF	Inverted file index.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IVF

public static final VectorIndexType IVF

Inverted file index. Best for faster approximate search with list/probe-style tuning.

HNSW

public static final VectorIndexType HNSW

Hierarchical Navigable Small World graph index. Best for high-recall approximate nearest-neighbor search.

Method Details

values

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