io.lettuce.core.vector

Enum QuantizationType

java.lang.Object

java.lang.Enum<QuantizationType>

io.lettuce.core.vector.QuantizationType

All Implemented Interfaces:

Serializable, Comparable<QuantizationType>

public enum QuantizationType
extends Enum<QuantizationType>

Enumeration of quantization types used for storing vectors in Redis Vector Sets.

Quantization affects how vectors are stored and impacts memory usage, performance, and recall quality. Different quantization types offer different trade-offs between memory usage, search speed, and accuracy.

Since:

6.7

Author:

Tihomir Mateev

See Also:

Redis Documentation: Quantization Effects

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Binary quantization.
NO_QUANTIZATION No quantization.
Q8 Signed 8-bit quantization.

Method Summary

Modifier and Type	Method and Description
String	getKeyword() Gets the command keyword string used in Redis commands for this quantization type.
static QuantizationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static QuantizationType[]	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

Enum Constant Detail

NO_QUANTIZATION

public static final QuantizationType NO_QUANTIZATION

No quantization. Vectors are stored as 32-bit floating point values.

This provides the highest precision but uses the most memory (4 bytes per dimension). Use this when precision is critical and memory usage is not a concern.

Corresponds to the NOQUANT option in Redis commands.

BINARY

public static final QuantizationType BINARY

Binary quantization. Vectors are stored as binary values (1 bit per dimension).

This is the most memory-efficient option (1 bit per dimension) and provides the fastest search, but has the lowest recall quality. Use this when memory usage and speed are critical, and some loss in recall quality is acceptable.

Corresponds to the BIN option in Redis commands.

Q8

public static final QuantizationType Q8

Signed 8-bit quantization. Vectors are stored as 8-bit integers.

This is the default quantization type and provides a good balance between memory usage (1 byte per dimension) and recall quality. Use this for most use cases.

Corresponds to the Q8 option in Redis commands.

Method Detail

values

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

Returns:

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

valueOf

public static QuantizationType 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

getKeyword

public String getKeyword()

Gets the command keyword string used in Redis commands for this quantization type.

Returns:

the command keyword string