io.lettuce.core.search.arguments

Enum VectorFieldArgs.Algorithm

java.lang.Object

java.lang.Enum<VectorFieldArgs.Algorithm>

io.lettuce.core.search.arguments.VectorFieldArgs.Algorithm

All Implemented Interfaces:

Serializable, Comparable<VectorFieldArgs.Algorithm>

Enclosing class:

VectorFieldArgs<K>

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

Vector similarity index algorithms.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLAT Brute force algorithm.
HNSW Hierarchical, navigable, small world algorithm.
SVS_VAMANA SVS-VAMANA algorithm provides high-performance approximate vector search optimized for specific use cases with advanced compression and optimization features.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLAT

public static final VectorFieldArgs.Algorithm FLAT

Brute force algorithm.

HNSW

public static final VectorFieldArgs.Algorithm HNSW

Hierarchical, navigable, small world algorithm.

SVS_VAMANA

public static final VectorFieldArgs.Algorithm SVS_VAMANA

SVS-VAMANA algorithm provides high-performance approximate vector search optimized for specific use cases with advanced compression and optimization features.

Characteristics:

• High-performance approximate search
• Support for vector compression (LVQ, LeanVec)
• Configurable graph construction and search parameters
• Optimized for Intel platforms with fallback support

Note: This algorithm may have specific requirements and limitations. Consult the Redis documentation for detailed usage guidelines.

Since:

Redis 8.2

Method Detail

values

public static VectorFieldArgs.Algorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VectorFieldArgs.Algorithm c : VectorFieldArgs.Algorithm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VectorFieldArgs.Algorithm valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<VectorFieldArgs.Algorithm>