redis.clients.jedis.search.schemafields

Enum VectorField.VectorAlgorithm

java.lang.Object

java.lang.Enum<VectorField.VectorAlgorithm>

redis.clients.jedis.search.schemafields.VectorField.VectorAlgorithm

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VectorField.VectorAlgorithm>, Rawable

Enclosing class:

VectorField

public static enum VectorField.VectorAlgorithm
extends java.lang.Enum<VectorField.VectorAlgorithm>
implements Rawable

Enumeration of supported vector indexing algorithms in Redis. Each algorithm has different performance characteristics and use cases.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLAT FLAT algorithm provides exact vector search with perfect accuracy.
HNSW HNSW (Hierarchical Navigable Small World) algorithm provides approximate vector search with configurable accuracy-performance trade-offs.
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
byte[]	getRaw() Returns the raw byte representation of the algorithm name for Redis commands.
static VectorField.VectorAlgorithm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VectorField.VectorAlgorithm[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface redis.clients.jedis.args.Rawable

equals, hashCode

Enum Constant Detail

FLAT

public static final VectorField.VectorAlgorithm FLAT

FLAT algorithm provides exact vector search with perfect accuracy. Best suited for smaller datasets (< 1M vectors) where search accuracy is more important than search latency.

HNSW

public static final VectorField.VectorAlgorithm HNSW

HNSW (Hierarchical Navigable Small World) algorithm provides approximate vector search with configurable accuracy-performance trade-offs. Best suited for larger datasets (> 1M vectors) where search performance and scalability are more important than perfect accuracy.

SVS_VAMANA

public static final VectorField.VectorAlgorithm 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.

Method Detail

values

public static VectorField.VectorAlgorithm[] 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 (VectorField.VectorAlgorithm c : VectorField.VectorAlgorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static VectorField.VectorAlgorithm valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getRaw

public byte[] getRaw()

Returns the raw byte representation of the algorithm name for Redis commands.

Specified by:

getRaw in interface Rawable

Returns:

the raw bytes of the algorithm name