Package com.redis.vl.schema

Enum Class VectorField.Algorithm

java.lang.Object

java.lang.Enum<VectorField.Algorithm>

com.redis.vl.schema.VectorField.Algorithm

All Implemented Interfaces:

Serializable, Comparable<VectorField.Algorithm>, Constable

Enclosing class:

VectorField

public static enum VectorField.Algorithm
extends Enum<VectorField.Algorithm>

Vector indexing algorithms

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
FLAT	FLAT algorithm for vector indexing
HNSW	HNSW algorithm for vector indexing

Method Summary

Modifier and Type	Method	Description
String	getValue()	Get the algorithm value
static VectorField.Algorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VectorField.Algorithm[]	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

FLAT

public static final VectorField.Algorithm FLAT

FLAT algorithm for vector indexing

HNSW

public static final VectorField.Algorithm HNSW

HNSW algorithm for vector indexing

Method Details

values

public static VectorField.Algorithm[] 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 VectorField.Algorithm 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

getValue

public String getValue()

Get the algorithm value

Returns:

Algorithm value