redis.clients.jedis.commands

Interface VectorSetPipelineCommands

All Known Subinterfaces:

PipelineCommands

All Known Implementing Classes:

AbstractPipeline, AbstractTransaction, ClusterPipeline, MultiDbPipeline, MultiDbTransaction, MultiNodePipelineBase, Pipeline, PipeliningBase, ReliableTransaction, Transaction

public interface VectorSetPipelineCommands

Interface for Redis Vector Set pipeline 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
Response<java.lang.Boolean>	vadd(java.lang.String key, float[] vector, java.lang.String element) VADD Command Add a new element into the vector set specified by key.
Response<java.lang.Boolean>	vadd(java.lang.String key, float[] vector, java.lang.String element, int reduceDim, VAddParams params) VADD Command Add a new element into the vector set specified by key with dimension reduction and additional parameters.
Response<java.lang.Boolean>	vadd(java.lang.String key, float[] vector, java.lang.String element, VAddParams params) VADD Command Add a new element into the vector set specified by key with additional parameters.
Response<java.lang.Boolean>	vaddFP32(java.lang.String key, byte[] vectorBlob, java.lang.String element) VADD Command Add a new element into the vector set specified by key using FP32 binary format.
Response<java.lang.Boolean>	vaddFP32(java.lang.String key, byte[] vectorBlob, java.lang.String 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.
Response<java.lang.Boolean>	vaddFP32(java.lang.String key, byte[] vectorBlob, java.lang.String element, VAddParams params) VADD Command Add a new element into the vector set specified by key using FP32 binary format with additional parameters.
Response<java.lang.Long>	vcard(java.lang.String key) VCARD Command Return the number of elements in the specified vector set.
Response<java.lang.Long>	vdim(java.lang.String key) VDIM Command Return the number of dimensions of the vectors in the specified vector set.
Response<java.util.List<java.lang.Double>>	vemb(java.lang.String key, java.lang.String element) VEMB Command Return the approximate vector associated with a given element in the vector set.
Response<RawVector>	vembRaw(java.lang.String key, java.lang.String element) VEMB Command Return the raw vector data associated with a given element in the vector set.
Response<java.lang.String>	vgetattr(java.lang.String key, java.lang.String element) VGETATTR Command Get the attributes of an element in a vector set.
Response<VectorInfo>	vinfo(java.lang.String key) VINFO Command Get information about a vector set.
Response<java.util.List<java.util.List<java.lang.String>>>	vlinks(java.lang.String key, java.lang.String element) VLINKS Command Return the neighbors of a specified element in a vector set.
Response<java.util.List<java.util.Map<java.lang.String,java.lang.Double>>>	vlinksWithScores(java.lang.String key, java.lang.String element) VLINKS Command Return the neighbors of a specified element in a vector set with similarity scores.
Response<java.lang.String>	vrandmember(java.lang.String key) VRANDMEMBER Command Return a random element from a vector set.
Response<java.util.List<java.lang.String>>	vrandmember(java.lang.String key, int count) VRANDMEMBER Command Return random elements from a vector set.
Response<java.lang.Boolean>	vrem(java.lang.String key, java.lang.String element) VREM Command Remove an element from a vector set.
Response<java.lang.Boolean>	vsetattr(java.lang.String key, java.lang.String element, java.lang.String attributes) VSETATTR Command Set the attributes of an element in a vector set.
Response<java.util.List<java.lang.String>>	vsim(java.lang.String key, float[] vector) VSIM Command Return elements similar to a given vector.
Response<java.util.List<java.lang.String>>	vsim(java.lang.String key, float[] vector, VSimParams params) VSIM Command Return elements similar to a given vector with additional parameters.
Response<java.util.List<java.lang.String>>	vsimByElement(java.lang.String key, java.lang.String element) VSIM Command Return elements similar to a given element in the vector set.
Response<java.util.List<java.lang.String>>	vsimByElement(java.lang.String key, java.lang.String element, VSimParams params) VSIM Command Return elements similar to a given element in the vector set with additional parameters.
Response<java.util.Map<java.lang.String,java.lang.Double>>	vsimByElementWithScores(java.lang.String key, java.lang.String element, VSimParams params) VSIM Command Return elements similar to a given element in the vector set with their similarity scores.
Response<java.util.Map<java.lang.String,java.lang.Double>>	vsimWithScores(java.lang.String key, float[] vector, VSimParams params) VSIM Command Return elements similar to a given vector with their similarity scores.

Method Detail

vadd

@Experimental
Response<java.lang.Boolean> vadd(java.lang.String key,
                                               float[] vector,
                                               java.lang.String 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:

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

vadd

@Experimental
Response<java.lang.Boolean> vadd(java.lang.String key,
                                               float[] vector,
                                               java.lang.String 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:

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

vaddFP32

@Experimental
Response<java.lang.Boolean> vaddFP32(java.lang.String key,
                                                   byte[] vectorBlob,
                                                   java.lang.String 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:

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

vaddFP32

@Experimental
Response<java.lang.Boolean> vaddFP32(java.lang.String key,
                                                   byte[] vectorBlob,
                                                   java.lang.String 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:

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

vadd

@Experimental
Response<java.lang.Boolean> vadd(java.lang.String key,
                                               float[] vector,
                                               java.lang.String 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:

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

vaddFP32

@Experimental
Response<java.lang.Boolean> vaddFP32(java.lang.String key,
                                                   byte[] vectorBlob,
                                                   java.lang.String 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:

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

vsim

@Experimental
Response<java.util.List<java.lang.String>> vsim(java.lang.String 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:

Response wrapping list of similar elements

vsim

@Experimental
Response<java.util.List<java.lang.String>> vsim(java.lang.String 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:

Response wrapping list of similar elements

vsimWithScores

@Experimental
Response<java.util.Map<java.lang.String,java.lang.Double>> vsimWithScores(java.lang.String 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:

Response wrapping map of element names to their similarity scores

vsimByElement

@Experimental
Response<java.util.List<java.lang.String>> vsimByElement(java.lang.String key,
                                                                       java.lang.String 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:

Response wrapping list of similar elements

vsimByElement

@Experimental
Response<java.util.List<java.lang.String>> vsimByElement(java.lang.String key,
                                                                       java.lang.String 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:

Response wrapping list of similar elements

vsimByElementWithScores

@Experimental
Response<java.util.Map<java.lang.String,java.lang.Double>> vsimByElementWithScores(java.lang.String key,
                                                                                                 java.lang.String 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:

Response wrapping map of element names to their similarity scores

vdim

@Experimental
Response<java.lang.Long> vdim(java.lang.String 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:

Response wrapping the number of vector set elements

vcard

@Experimental
Response<java.lang.Long> vcard(java.lang.String 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:

Response wrapping the number of elements in the vector set

vemb

@Experimental
Response<java.util.List<java.lang.Double>> vemb(java.lang.String key,
                                                              java.lang.String 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:

Response wrapping list of real numbers representing the vector

vembRaw

@Experimental
Response<RawVector> vembRaw(java.lang.String key,
                                          java.lang.String 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:

Response wrapping RawVector containing raw vector data, quantization type, and metadata

vrem

@Experimental
Response<java.lang.Boolean> vrem(java.lang.String key,
                                               java.lang.String 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:

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

vlinks

@Experimental
Response<java.util.List<java.util.List<java.lang.String>>> vlinks(java.lang.String key,
                                                                                java.lang.String 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:

Response wrapping list of neighbor element names

vlinksWithScores

@Experimental
Response<java.util.List<java.util.Map<java.lang.String,java.lang.Double>>> vlinksWithScores(java.lang.String key,
                                                                                                          java.lang.String 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:

Response wrapping map of neighbor element names to similarity scores

vrandmember

@Experimental
Response<java.lang.String> vrandmember(java.lang.String 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:

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

vrandmember

@Experimental
Response<java.util.List<java.lang.String>> vrandmember(java.lang.String 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:

Response wrapping list of random element names

vgetattr

@Experimental
Response<java.lang.String> vgetattr(java.lang.String key,
                                                  java.lang.String 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:

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

vsetattr

@Experimental
Response<java.lang.Boolean> vsetattr(java.lang.String key,
                                                   java.lang.String element,
                                                   java.lang.String 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:

Response wrapping true if the attributes were set successfully

vinfo

@Experimental
Response<VectorInfo> vinfo(java.lang.String key)

VINFO Command Get information about a vector set.

Time complexity: O(1)

Parameters:

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

Returns:

Response wrapping information about the vector set