redis.clients.jedis.commands

Interface VectorSetBinaryCommands

All Known Subinterfaces:

JedisBinaryCommands

All Known Implementing Classes:

Jedis, JedisCluster, JedisPooled, JedisSentineled, MultiDbClient, UnifiedJedis

public interface VectorSetBinaryCommands

Interface for Redis Vector Set binary commands. Vector sets are a new data type introduced in Redis 8.0 for vector similarity operations.

Method Summary

Modifier and Type	Method and Description
boolean	vadd(byte[] key, float[] vector, byte[] element) VADD Command Add a new element into the vector set specified by key.
boolean	vadd(byte[] key, float[] vector, byte[] element, int reduceDim, VAddParams params) VADD Command Add a new element into the vector set specified by key with dimension reduction and additional parameters.
boolean	vadd(byte[] key, float[] vector, byte[] element, VAddParams params) VADD Command Add a new element into the vector set specified by key with additional parameters.
boolean	vaddFP32(byte[] key, byte[] vectorBlob, byte[] element) VADD Command Add a new element into the vector set specified by key using FP32 binary format.
boolean	vaddFP32(byte[] key, byte[] vectorBlob, byte[] element, int reduceDim, VAddParams params) VADD Command Add a new element into the vector set specified by key using FP32 binary format with dimension reduction and additional parameters.
boolean	vaddFP32(byte[] key, byte[] vectorBlob, byte[] element, VAddParams params) VADD Command Add a new element into the vector set specified by key using FP32 binary format with additional parameters.
long	vcard(byte[] key) VCARD Command Return the number of elements in the specified vector set.
long	vdim(byte[] key) VDIM Command Return the number of dimensions of the vectors in the specified vector set.
java.util.List<java.lang.Double>	vemb(byte[] key, byte[] element) VEMB Command Return the approximate vector associated with a given element in the vector set.
RawVector	vembRaw(byte[] key, byte[] element) VEMB Command Return the raw vector data associated with a given element in the vector set.
byte[]	vgetattr(byte[] key, byte[] element) VGETATTR Command Get the attributes of an element in a vector set.
java.util.List<java.util.List<byte[]>>	vlinks(byte[] key, byte[] element) VLINKS Command Return the neighbors of a specified element in a vector set.
java.util.List<java.util.Map<byte[],java.lang.Double>>	vlinksWithScores(byte[] key, byte[] element) VLINKS Command Return the neighbors of a specified element in a vector set with similarity scores.
byte[]	vrandmember(byte[] key) VRANDMEMBER Command Return a random element from a vector set.
java.util.List<byte[]>	vrandmember(byte[] key, int count) VRANDMEMBER Command Return random elements from a vector set.
boolean	vrem(byte[] key, byte[] element) VREM Command Remove an element from a vector set.
boolean	vsetattr(byte[] key, byte[] element, byte[] attributes) VSETATTR Command Set the attributes of an element in a vector set.
java.util.List<byte[]>	vsim(byte[] key, float[] vector) VSIM Command Return elements similar to a given vector.
java.util.List<byte[]>	vsim(byte[] key, float[] vector, VSimParams params) VSIM Command Return elements similar to a given vector with additional parameters.
java.util.List<byte[]>	vsimByElement(byte[] key, byte[] element) VSIM Command Return elements similar to a given element in the vector set.
java.util.List<byte[]>	vsimByElement(byte[] key, byte[] element, VSimParams params) VSIM Command Return elements similar to a given element in the vector set with additional parameters.
java.util.Map<byte[],java.lang.Double>	vsimByElementWithScores(byte[] key, byte[] element, VSimParams params) VSIM Command Return elements similar to a given element in the vector set with their similarity scores.
java.util.Map<byte[],VSimScoreAttribs>	vsimByElementWithScoresAndAttribs(byte[] key, byte[] element, VSimParams params) VSIM Command Return elements similar to a given element in the vector set with their similarity scores and attributes.
java.util.Map<byte[],java.lang.Double>	vsimWithScores(byte[] key, float[] vector, VSimParams params) VSIM Command Return elements similar to a given vector with their similarity scores.
java.util.Map<byte[],VSimScoreAttribs>	vsimWithScoresAndAttribs(byte[] key, float[] vector, VSimParams params) VSIM Command Return elements similar to a given vector with their similarity scores and attributes.

Method Detail

vadd

@Experimental
boolean vadd(byte[] key,
                           float[] vector,
                           byte[] element)

VADD Command Add a new element into the vector set specified by key.

Time complexity: O(log(N)) for each element added, where N is the number of elements in the vector set.

Parameters:

key - the name of the key that will hold the vector set data

vector - the vector as floating point numbers

element - the name of the element that is being added to the vector set

Returns:

1 if key was added; 0 if key was not added

vadd

@Experimental
boolean vadd(byte[] key,
                           float[] vector,
                           byte[] element,
                           VAddParams params)

VADD Command Add a new element into the vector set specified by key with additional parameters.

Time complexity: O(log(N)) for each element added, where N is the number of elements in the vector set.

Parameters:

key - the name of the key that will hold the vector set data

vector - the vector as floating point numbers

element - the name of the element that is being added to the vector set

params - additional parameters for the VADD command

Returns:

1 if key was added; 0 if key was not added

vaddFP32

@Experimental
boolean vaddFP32(byte[] key,
                               byte[] vectorBlob,
                               byte[] element)

VADD Command Add a new element into the vector set specified by key using FP32 binary format.

Time complexity: O(log(N)) for each element added, where N is the number of elements in the vector set.

Parameters:

key - the name of the key that will hold the vector set data

vectorBlob - the vector as FP32 binary blob

element - the name of the element that is being added to the vector set

Returns:

1 if key was added; 0 if key was not added

vaddFP32

@Experimental
boolean vaddFP32(byte[] key,
                               byte[] vectorBlob,
                               byte[] element,
                               VAddParams params)

VADD Command Add a new element into the vector set specified by key using FP32 binary format with additional parameters.

Time complexity: O(log(N)) for each element added, where N is the number of elements in the vector set.

Parameters:

key - the name of the key that will hold the vector set data

vectorBlob - the vector as FP32 binary blob

element - the name of the element that is being added to the vector set

params - additional parameters for the VADD command

Returns:

1 if key was added; 0 if key was not added

vadd

@Experimental
boolean vadd(byte[] key,
                           float[] vector,
                           byte[] element,
                           int reduceDim,
                           VAddParams params)

VADD Command Add a new element into the vector set specified by key with dimension reduction and additional parameters.

Time complexity: O(log(N)) for each element added, where N is the number of elements in the vector set.

Parameters:

key - the name of the key that will hold the vector set data

vector - the vector as floating point numbers

element - the name of the element that is being added to the vector set

reduceDim - the target dimension after reduction using random projection

params - additional parameters for the VADD command

Returns:

1 if key was added; 0 if key was not added

vaddFP32

@Experimental
boolean vaddFP32(byte[] key,
                               byte[] vectorBlob,
                               byte[] element,
                               int reduceDim,
                               VAddParams params)

VADD Command Add a new element into the vector set specified by key using FP32 binary format with dimension reduction and additional parameters.

Time complexity: O(log(N)) for each element added, where N is the number of elements in the vector set.

Parameters:

key - the name of the key that will hold the vector set data

vectorBlob - the vector as FP32 binary blob

element - the name of the element that is being added to the vector set

reduceDim - the target dimension after reduction using random projection

params - additional parameters for the VADD command

Returns:

1 if key was added; 0 if key was not added

vsim

@Experimental
java.util.List<byte[]> vsim(byte[] key,
                                          float[] vector)

VSIM Command Return elements similar to a given vector.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

vector - the vector to use as similarity reference

Returns:

list of similar elements

vsim

@Experimental
java.util.List<byte[]> vsim(byte[] key,
                                          float[] vector,
                                          VSimParams params)

VSIM Command Return elements similar to a given vector with additional parameters.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

vector - the vector to use as similarity reference

params - additional parameters for the VSIM command

Returns:

list of similar elements

vsimWithScores

@Experimental
java.util.Map<byte[],java.lang.Double> vsimWithScores(byte[] key,
                                                                    float[] vector,
                                                                    VSimParams params)

VSIM Command Return elements similar to a given vector with their similarity scores.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

vector - the vector to use as similarity reference

params - additional parameters for the VSIM command (WITHSCORES will be automatically added)

Returns:

map of element names to their similarity scores

vsimWithScoresAndAttribs

@Experimental
java.util.Map<byte[],VSimScoreAttribs> vsimWithScoresAndAttribs(byte[] key,
                                                                              float[] vector,
                                                                              VSimParams params)

VSIM Command Return elements similar to a given vector with their similarity scores and attributes.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

vector - the vector to use as similarity reference

params - additional parameters for the VSIM command (WITHSCORES and WITHATTRIBS will be automatically added)

Returns:

map of element names to their similarity scores and attributes

vsimByElement

@Experimental
java.util.List<byte[]> vsimByElement(byte[] key,
                                                   byte[] element)

VSIM Command Return elements similar to a given element in the vector set.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

element - the name of the element to use as similarity reference

Returns:

list of similar elements

vsimByElement

@Experimental
java.util.List<byte[]> vsimByElement(byte[] key,
                                                   byte[] element,
                                                   VSimParams params)

VSIM Command Return elements similar to a given element in the vector set with additional parameters.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

element - the name of the element to use as similarity reference

params - additional parameters for the VSIM command

Returns:

list of similar elements

vsimByElementWithScores

@Experimental
java.util.Map<byte[],java.lang.Double> vsimByElementWithScores(byte[] key,
                                                                             byte[] element,
                                                                             VSimParams params)

VSIM Command Return elements similar to a given element in the vector set with their similarity scores.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

element - the name of the element to use as similarity reference

params - additional parameters for the VSIM command (WITHSCORES will be automatically added)

Returns:

map of element names to their similarity scores

vsimByElementWithScoresAndAttribs

@Experimental
java.util.Map<byte[],VSimScoreAttribs> vsimByElementWithScoresAndAttribs(byte[] key,
                                                                                       byte[] element,
                                                                                       VSimParams params)

VSIM Command Return elements similar to a given element in the vector set with their similarity scores and attributes.

Time complexity: O(log(N)) where N is the number of elements in the vector set.

Parameters:

key - the name of the key that holds the vector set data

element - the name of the element to use as similarity reference

params - additional parameters for the VSIM command (WITHSCORES and WITHATTRIBS will be automatically added)

Returns:

map of element names to their similarity scores and attributes

vdim

@Experimental
long vdim(byte[] key)

VDIM Command Return the number of dimensions of the vectors in the specified vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

Returns:

the number of vector set elements

vcard

@Experimental
long vcard(byte[] key)

VCARD Command Return the number of elements in the specified vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

Returns:

the number of elements in the vector set

vemb

@Experimental
java.util.List<java.lang.Double> vemb(byte[] key,
                                                    byte[] element)

VEMB Command Return the approximate vector associated with a given element in the vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

element - the name of the element whose vector you want to retrieve

Returns:

list of real numbers representing the vector

vembRaw

RawVector vembRaw(byte[] key,
                  byte[] element)

VEMB Command Return the raw vector data associated with a given element in the vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

element - the name of the element whose vector you want to retrieve

Returns:

RawVector containing raw vector data, quantization type, and metadata

vrem

@Experimental
boolean vrem(byte[] key,
                           byte[] element)

VREM Command Remove an element from a vector set.

Time complexity: O(log(N)) for each element removed, where N is the number of elements in the vector set

Parameters:

key - the name of the key that holds the vector set

element - the name of the element to remove from the vector set

Returns:

true if the element was removed, false if either element or key do not exist

vlinks

@Experimental
java.util.List<java.util.List<byte[]>> vlinks(byte[] key,
                                                            byte[] element)

VLINKS Command Return the neighbors of a specified element in a vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

element - the name of the element whose HNSW neighbors you want to inspect

Returns:

list of neighbor element names

vlinksWithScores

@Experimental
java.util.List<java.util.Map<byte[],java.lang.Double>> vlinksWithScores(byte[] key,
                                                                                      byte[] element)

VLINKS Command Return the neighbors of a specified element in a vector set with similarity scores.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

element - the name of the element whose HNSW neighbors you want to inspect

Returns:

List of map of neighbor element names to similarity scores per layer

vrandmember

@Experimental
byte[] vrandmember(byte[] key)

VRANDMEMBER Command Return a random element from a vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

Returns:

a random element name, or null if the key does not exist

vrandmember

@Experimental
java.util.List<byte[]> vrandmember(byte[] key,
                                                 int count)

VRANDMEMBER Command Return random elements from a vector set.

Time complexity: O(N) where N is the absolute value of the count argument

Parameters:

key - the name of the key that holds the vector set

count - the number of elements to return. Positive values return distinct elements; negative values allow duplicates

Returns:

list of random element names

vgetattr

@Experimental
byte[] vgetattr(byte[] key,
                              byte[] element)

VGETATTR Command Get the attributes of an element in a vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

element - the name of the element whose attributes to retrieve

Returns:

the attributes of the element as a JSON string, or null if the element doesn't exist or has no attributes

vsetattr

@Experimental
boolean vsetattr(byte[] key,
                               byte[] element,
                               byte[] attributes)

VSETATTR Command Set the attributes of an element in a vector set.

Time complexity: O(1)

Parameters:

key - the name of the key that holds the vector set

element - the name of the element whose attributes to set

attributes - the attributes to set as a JSON string

Returns:

true if the attributes were set successfully