io.lettuce.core.vector

Class RawVector

java.lang.Object

io.lettuce.core.vector.RawVector

public class RawVector
extends Object

Represents a raw vector returned by the Redis VEMB command with the RAW option.

This class encapsulates the binary representation of a vector along with metadata about its quantization type, normalization factor, and quantization range. The raw binary format allows for efficient storage and processing of vector data.

The VEMB command with RAW option returns the following data:

1. The quantization type as a string: "int8" (Q8), "float32" (NOQUANT), or "binary" (BIN)
2. A binary blob containing the raw vector data
3. The L2 norm of the vector before normalization
4. The quantization range (only for Q8 quantization)

Since:

6.7

Author:

Tihomir Mateev

See Also:

Redis Documentation: VEMB

Constructor Summary

Constructors

Constructor and Description
RawVector() Creates a new empty raw vector.
RawVector(QuantizationType type, ByteBuffer vector, Double beforeNormalization, Double quantizationRange) Creates a new raw vector with the specified properties.

Method Summary

Modifier and Type	Method and Description
Double	beforeNormalization() Gets the L2 norm of the vector before normalization.
Double	getQuantizationRange() Gets the quantization range used for Q8 quantization.
QuantizationType	getType() Gets the quantization type used for storing the vector.
ByteBuffer	getVector() Gets the raw binary data of the vector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RawVector

public RawVector(QuantizationType type,
                 ByteBuffer vector,
                 Double beforeNormalization,
                 Double quantizationRange)

Creates a new raw vector with the specified properties.

Parameters:

type - the quantization type used for storing the vector

vector - the raw binary data of the vector

beforeNormalization - the L2 norm of the vector before normalization

quantizationRange - the quantization range (only for Q8 quantization)

RawVector

public RawVector()

Creates a new empty raw vector.

This constructor creates an empty raw vector object. The fields will be populated when the object is used to parse the response from a Redis VEMB command with the RAW option.

Method Detail

getType

public QuantizationType getType()

Gets the quantization type used for storing the vector.

Returns:

the quantization type, or null if not available

getVector

public ByteBuffer getVector()

Gets the raw binary data of the vector.

The format of this data depends on the quantization type.

Returns:

the raw binary data of the vector, or null if not available

beforeNormalization

public Double beforeNormalization()

Gets the L2 norm of the vector before normalization.

This value represents the original magnitude of the vector before it was normalized for storage in the vector set.

Returns:

the L2 norm of the vector before normalization, or null if not available

getQuantizationRange

public Double getQuantizationRange()

Gets the quantization range used for Q8 quantization.

This value is only present for vectors with Q8 quantization and is used to convert between the 8-bit integer representation and the original floating point values.

Returns:

the quantization range, or null if not available or not using Q8 quantization