VectorMetadata (Lettuce 7.0.0.RELEASE API)

java.lang.Object
- io.lettuce.core.vector.VectorMetadata

```
public class VectorMetadata
extends Object
```
Represents metadata and internal details about a Redis vector set.
This class encapsulates information returned by the Redis VINFO command, including size, dimensions, quantization type, and graph structure parameters of a vector set.
Vector sets are a Redis data type designed for storing and searching high-dimensional vectors. They support approximate nearest neighbor search using the HNSW (Hierarchical Navigable Small World) algorithm.
The metadata provides insights into the configuration and state of a vector set, which can be useful for monitoring, debugging, and understanding the performance characteristics of vector operations.

Since:

6.7

Author:

Tihomir Mateev

See Also:

Redis Documentation: VINFO, Redis Documentation: Vector Sets

Constructor Summary

Constructors
Constructor and Description

VectorMetadata()
Creates a new empty VectorMetadata instance.

Constructors
Constructor and Description
`VectorMetadata()` Creates a new empty `VectorMetadata` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getAttributesCount()` Gets the number of elements in the vector set that have attributes.
`Integer`	`getDimensionality()` Gets the dimensionality of the vectors in the vector set.
`Integer`	`getMaxLevel()` Gets the maximum level in the HNSW graph.
`Integer`	`getMaxNodes()` Gets the maximum number of connections per node in the HNSW graph.
`Integer`	`getMaxNodeUid()` Gets the maximum node UID in the HNSW graph.
`Integer`	`getProjectionInputDim()` Gets the original dimensionality of vectors before dimensionality reduction.
`Integer`	`getSize()` Gets the number of elements (vectors) in the vector set.
`QuantizationType`	`getType()` Gets the quantization type used for storing vectors in the vector set.
`Integer`	`getvSetUid()` Gets the unique identifier of the vector set.
`void`	`setAttributesCount(Integer value)` Sets the number of elements in the vector set that have attributes.
`void`	`setDimensionality(Integer value)` Sets the dimensionality of the vectors in the vector set.
`void`	`setMaxLevel(Integer value)` Sets the maximum level in the HNSW graph.
`void`	`setMaxNodes(Integer value)` Sets the maximum number of connections per node in the HNSW graph.
`void`	`setMaxNodeUid(Integer value)` Sets the maximum node UID in the HNSW graph.
`void`	`setProjectionInputDim(Integer value)` Sets the original dimensionality of vectors before dimensionality reduction.
`void`	`setSize(Integer value)` Sets the number of elements (vectors) in the vector set.
`void`	`setType(QuantizationType value)` Sets the quantization type used for storing vectors in the vector set.
`void`	`setvSetUid(Integer value)` Sets the unique identifier of the vector set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VectorMetadata
```
public VectorMetadata()
```
    Creates a new empty VectorMetadata instance.
    This constructor creates an empty metadata object. The fields will be populated when the object is used to parse the response from a Redis VINFO command.
- Method Detail
  - getDimensionality
```
public Integer getDimensionality()
```
    Gets the dimensionality of the vectors in the vector set.
    This represents the number of dimensions (features) in each vector. All vectors in a vector set must have the same dimensionality. Higher dimensionality vectors can represent more complex data but require more memory and processing power.
    
    Returns:
    
    the number of dimensions for each vector in the vector set, or null if not available
    
    See Also:
    
    Memory Optimization
  - getType
```
public QuantizationType getType()
```
    Gets the quantization type used for storing vectors in the vector set.
    Quantization affects how vectors are stored and impacts memory usage, performance, and recall quality.
    Common types include:
    - Q8 - Uses signed 8-bit quantization, balancing memory usage and recall quality
    - NOQUANT - Stores vectors without quantization, using more memory but preserving full precision
    - BIN - Uses binary quantization, which is faster and uses less memory, but impacts recall quality
    Returns:
    
    the quantization type used for the vector set, or null if not available
    
    See Also:
    
    Quantization Effects
  - getSize
```
public Integer getSize()
```
    Gets the number of elements (vectors) in the vector set.
    This represents the total count of vectors currently stored in the vector set. This is equivalent to the result of the VCARD command.
    
    Returns:
    
    the total count of vectors in the vector set, or null if not available
    
    See Also:
    
    VCARD Command
  - getMaxNodeUid
```
public Integer getMaxNodeUid()
```
    Gets the maximum node UID in the HNSW graph.
    This is an internal identifier used by Redis to track nodes in the HNSW graph. It can be useful for debugging and monitoring purposes.
    
    Returns:
    
    the maximum node UID in the HNSW graph, or null if not available
  - getvSetUid
```
public Integer getvSetUid()
```
    Gets the unique identifier of the vector set.
    This is an internal identifier used by Redis to track the vector set. It can be useful for debugging and monitoring purposes.
    
    Returns:
    
    the unique identifier used by Redis to track the vector set, or null if not available
  - getMaxNodes
```
public Integer getMaxNodes()
```
    Gets the maximum number of connections per node in the HNSW graph.
    This parameter (also known as M) specifies the maximum number of connections that each node of the graph will have with other nodes. More connections means more memory, but provides for more efficient graph exploration.
    Higher values improve recall at the cost of memory usage and indexing speed.
    
    Returns:
    
    the maximum number of connections per node, or null if not available
    
    See Also:
    
    HNSW Parameters
  - getProjectionInputDim
```
public Integer getProjectionInputDim()
```
    Gets the original dimensionality of vectors before dimensionality reduction.
    When using the REDUCE option with VADD, this field indicates the original dimensionality of the vectors before they were projected to a lower-dimensional space.
    
    Returns:
    
    the original dimensionality before reduction, or null if dimensionality reduction is not used
    
    See Also:
    
    Dimensionality Reduction
  - getAttributesCount
```
public Integer getAttributesCount()
```
    Gets the number of elements in the vector set that have attributes.
    Attributes are JSON metadata associated with vector elements that can be used for filtering in similarity searches.
    
    Returns:
    
    the number of elements with attributes, or null if not available
    
    See Also:
    
    Filtered Search
  - getMaxLevel
```
public Integer getMaxLevel()
```
    Gets the maximum level in the HNSW graph.
    The HNSW algorithm organizes vectors in a hierarchical graph with multiple levels. This parameter indicates the highest level in the graph structure.
    Higher levels enable faster navigation through the graph during similarity searches.
    
    Returns:
    
    the maximum level in the HNSW graph, or null if not available
    
    See Also:
    
    HNSW Parameters
  - setDimensionality
```
public void setDimensionality(Integer value)
```
    Sets the dimensionality of the vectors in the vector set.
    
    Parameters:
    
    value - the number of dimensions for each vector in the vector set
  - setType
```
public void setType(QuantizationType value)
```
    Sets the quantization type used for storing vectors in the vector set.
    
    Parameters:
    
    value - the quantization type (Q8, NOQUANT, or BIN)
  - setSize
```
public void setSize(Integer value)
```
    Sets the number of elements (vectors) in the vector set.
    
    Parameters:
    
    value - the total count of vectors in the vector set
  - setMaxNodeUid
```
public void setMaxNodeUid(Integer value)
```
    Sets the maximum node UID in the HNSW graph.
    This is an internal identifier used by Redis to track nodes in the HNSW graph.
    
    Parameters:
    
    value - the maximum node UID in the HNSW graph
  - setvSetUid
```
public void setvSetUid(Integer value)
```
    Sets the unique identifier of the vector set.
    
    Parameters:
    
    value - the unique identifier used by Redis to track the vector set
  - setMaxNodes
```
public void setMaxNodes(Integer value)
```
    Sets the maximum number of connections per node in the HNSW graph.
    This parameter (also known as M) affects the memory usage and search performance of the vector set.
    
    Parameters:
    
    value - the maximum number of connections per node
  - setProjectionInputDim
```
public void setProjectionInputDim(Integer value)
```
    Sets the original dimensionality of vectors before dimensionality reduction.
    This is used when the REDUCE option is specified with VADD.
    
    Parameters:
    
    value - the original dimensionality before reduction
  - setAttributesCount
```
public void setAttributesCount(Integer value)
```
    Sets the number of elements in the vector set that have attributes.
    
    Parameters:
    
    value - the number of elements with attributes
  - setMaxLevel
```
public void setMaxLevel(Integer value)
```
    Sets the maximum level in the HNSW graph.
    The HNSW algorithm organizes vectors in a hierarchical graph with multiple levels. Higher levels enable faster navigation through the graph during similarity searches.
    Corresponds to the max-level field in the VINFO command response.
    
    Parameters:
    
    value - the maximum level in the HNSW graph

Class VectorMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VectorMetadata

Method Detail

getDimensionality

getType

getSize

getMaxNodeUid

getvSetUid

getMaxNodes

getProjectionInputDim

getAttributesCount

getMaxLevel

setDimensionality

setType

setSize

setMaxNodeUid

setvSetUid

setMaxNodes

setProjectionInputDim

setAttributesCount

setMaxLevel