io.lettuce.core

Class RedisVectorSetCommandBuilder<K,V>

java.lang.Object

io.lettuce.core.protocol.BaseRedisCommandBuilder<K,V>

io.lettuce.core.RedisVectorSetCommandBuilder<K,V>

Type Parameters:

K - Key type.

V - Value type.

public class RedisVectorSetCommandBuilder<K,V>
extends BaseRedisCommandBuilder<K,V>

Implementation of the BaseRedisCommandBuilder handling Vector Set commands.

Since:

6.7

Author:

Tihomir Mateev

Field Summary

Fields inherited from class io.lettuce.core.protocol.BaseRedisCommandBuilder

codec, MINUS_BYTES, MUST_NOT_BE_EMPTY, MUST_NOT_BE_NULL, MUST_NOT_CONTAIN_NULL_ELEMENTS, PLUS_BYTES

Constructor Summary

Constructors

Constructor and Description
RedisVectorSetCommandBuilder(RedisCodec<K,V> codec, Supplier<JsonParser> parser) Initialize a new RedisVectorSetCommandBuilder with the specified codec.

Method Summary

Modifier and Type	Method and Description
Command<K,V,Boolean>	vadd(K key, int dimensionality, V element, Double[] vectors) Create a new VADD command to add a vector to a vector set with the specified dimensionality.
Command<K,V,Boolean>	vadd(K key, int dimensionality, V element, VAddArgs vAddArgs, Double[] vectors) Create a new VADD command to add a vector to a vector set with the specified dimensionality and additional options.
Command<K,V,Boolean>	vadd(K key, V element, Double[] vectors) Create a new VADD command to add a vector to a vector set.
Command<K,V,Boolean>	vadd(K key, V element, VAddArgs vAddArgs, Double[] vectors) Create a new VADD command to add a vector to a vector set with additional options.
Command<K,V,Long>	vcard(K key) Create a new VCARD command to get the number of elements in a vector set.
Command<K,V,Long>	vdim(K key) Create a new VDIM command to get the dimensionality of a vector set.
Command<K,V,List<Double>>	vemb(K key, V element) Create a new VEMB command to get the vector values for an element in a vector set.
Command<K,V,RawVector>	vembRaw(K key, V element) Create a new VEMB command with the RAW option to get the raw binary vector data for an element in a vector set.
Command<K,V,String>	vgetattr(K key, V element) Create a new VGETATTR command to get the attributes associated with an element in a vector set.
Command<K,V,List<JsonValue>>	vgetattrAsJsonValue(K key, V element) Create a new VGETATTR command to get the attributes associated with an element in a vector set.
Command<K,V,VectorMetadata>	vinfo(K key) Create a new VINFO command to get information about a vector set.
Command<K,V,List<V>>	vlinks(K key, V element) Create a new VLINKS command to get the links (connections) of an element in the HNSW graph.
Command<K,V,Map<V,Double>>	vlinksWithScores(K key, V element) Create a new VLINKS command with the WITHSCORES option to get the links of an element along with their scores.
Command<K,V,V>	vrandmember(K key) Create a new VRANDMEMBER command to get a random element from a vector set.
Command<K,V,List<V>>	vrandmember(K key, int count) Create a new VRANDMEMBER command to get multiple random elements from a vector set.
Command<K,V,Boolean>	vrem(K key, V element) Create a new VREM command to remove an element from a vector set.
Command<K,V,Boolean>	vsetattr(K key, V element, JsonValue json) Create a new VSETATTR command to set or update the attributes for an element in a vector set.
Command<K,V,Boolean>	vsetattr(K key, V element, String json) Create a new VSETATTR command to set or update the attributes for an element in a vector set.
Command<K,V,List<V>>	vsim(K key, Double[] vectors) Create a new VSIM command to find the most similar vectors to the given query vector in a vector set.
Command<K,V,List<V>>	vsim(K key, V element) Create a new VSIM command to find the most similar vectors to the given element's vector in a vector set.
Command<K,V,List<V>>	vsim(K key, VSimArgs vSimArgs, Double[] vectors) Create a new VSIM command to find the most similar vectors to the given query vector in a vector set with additional options.
Command<K,V,List<V>>	vsim(K key, VSimArgs vSimArgs, V element) Create a new VSIM command to find the most similar vectors to the given element's vector in a vector set with additional options.
Command<K,V,Map<V,Double>>	vsimWithScore(K key, Double[] vectors) Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given query vector and return them with their similarity scores.
Command<K,V,Map<V,Double>>	vsimWithScore(K key, V element) Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given element's vector and return them with their similarity scores.
Command<K,V,Map<V,Double>>	vsimWithScore(K key, VSimArgs vSimArgs, Double[] vectors) Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given query vector with additional options and return them with their similarity scores.
Command<K,V,Map<V,Double>>	vsimWithScore(K key, VSimArgs vSimArgs, V element) Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given element's vector with additional options and return them with their similarity scores.

Methods inherited from class io.lettuce.core.protocol.BaseRedisCommandBuilder

addLimit, allElementsInstanceOf, assertNodeId, createCommand, createCommand, createCommand, createCommand, createCommand, keyAndFieldsProvided, max, maxValue, min, minValue, newScriptOutput, notEmpty, notEmptyRanges, notEmptySlots, notEmptyValues, notNull, notNull, notNull, notNull, notNullKey, notNullLimit, notNullMinMax, notNullRange

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisVectorSetCommandBuilder

public RedisVectorSetCommandBuilder(RedisCodec<K,V> codec,
                                    Supplier<JsonParser> parser)

Initialize a new RedisVectorSetCommandBuilder with the specified codec.

Parameters:

codec - the codec used to encode/decode keys and values, must not be null

parser -

Method Detail

vadd

public Command<K,V,Boolean> vadd(K key,
                                 V element,
                                 Double[] vectors)

Create a new VADD command to add a vector to a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element being added to the vector set, must not be null

vectors - the vector values as floating point numbers, must not be empty

Returns:

a new Command that adds a vector to a vector set

See Also:

Redis Documentation: VADD

vadd

public Command<K,V,Boolean> vadd(K key,
                                 int dimensionality,
                                 V element,
                                 Double[] vectors)

Create a new VADD command to add a vector to a vector set with the specified dimensionality.

Parameters:

key - the key of the vector set, must not be null

dimensionality - the number of dimensions for the vector

element - the name of the element being added to the vector set, must not be null

vectors - the vector values as floating point numbers, must not be empty

Returns:

a new Command that adds a vector to a vector set with the specified dimensionality

See Also:

Redis Documentation: VADD

vadd

public Command<K,V,Boolean> vadd(K key,
                                 V element,
                                 VAddArgs vAddArgs,
                                 Double[] vectors)

Create a new VADD command to add a vector to a vector set with additional options.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element being added to the vector set, must not be null

vAddArgs - the additional arguments for the VADD command

vectors - the vector values as floating point numbers, must not be empty

Returns:

a new Command that adds a vector to a vector set with additional options

See Also:

Redis Documentation: VADD

vadd

public Command<K,V,Boolean> vadd(K key,
                                 int dimensionality,
                                 V element,
                                 VAddArgs vAddArgs,
                                 Double[] vectors)

Create a new VADD command to add a vector to a vector set with the specified dimensionality and additional options.

Parameters:

key - the key of the vector set, must not be null

dimensionality - the number of dimensions for the vector

element - the name of the element being added to the vector set, must not be null

vAddArgs - the additional arguments for the VADD command

vectors - the vector values as floating point numbers, must not be empty

Returns:

a new Command that adds a vector to a vector set with the specified dimensionality and additional options

See Also:

Redis Documentation: VADD

vcard

public Command<K,V,Long> vcard(K key)

Create a new VCARD command to get the number of elements in a vector set.

Parameters:

key - the key of the vector set, must not be null

Returns:

a new Command that returns the number of elements in the vector set

See Also:

Redis Documentation: VCARD

vdim

public Command<K,V,Long> vdim(K key)

Create a new VDIM command to get the dimensionality of a vector set.

Parameters:

key - the key of the vector set, must not be null

Returns:

a new Command that returns the dimensionality of the vector set

See Also:

Redis Documentation: VDIM

vemb

public Command<K,V,List<Double>> vemb(K key,
                                      V element)

Create a new VEMB command to get the vector values for an element in a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

Returns:

a new Command that returns the vector values for the specified element

See Also:

Redis Documentation: VEMB

vembRaw

public Command<K,V,RawVector> vembRaw(K key,
                                      V element)

Create a new VEMB command with the RAW option to get the raw binary vector data for an element in a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

Returns:

a new Command that returns the raw vector data for the specified element

See Also:

Redis Documentation: VEMB

vgetattr

public Command<K,V,String> vgetattr(K key,
                                    V element)

Create a new VGETATTR command to get the attributes associated with an element in a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

Returns:

a new Command that returns the attributes associated with the specified element

See Also:

Redis Documentation: VGETATTR

vgetattrAsJsonValue

public Command<K,V,List<JsonValue>> vgetattrAsJsonValue(K key,
                                                        V element)

Create a new VGETATTR command to get the attributes associated with an element in a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

Returns:

a new Command that returns the attributes associated with the specified element

See Also:

Redis Documentation: VGETATTR

vinfo

public Command<K,V,VectorMetadata> vinfo(K key)

Create a new VINFO command to get information about a vector set.

Parameters:

key - the key of the vector set, must not be null

Returns:

a new Command that returns metadata about the vector set

See Also:

Redis Documentation: VINFO

vlinks

public Command<K,V,List<V>> vlinks(K key,
                                   V element)

Create a new VLINKS command to get the links (connections) of an element in the HNSW graph.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

Returns:

a new Command that returns a list of elements that are linked to the specified element

See Also:

Redis Documentation: VLINKS

vlinksWithScores

public Command<K,V,Map<V,Double>> vlinksWithScores(K key,
                                                   V element)

Create a new VLINKS command with the WITHSCORES option to get the links of an element along with their scores.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

Returns:

a new Command that returns a list of elements with their similarity scores

See Also:

Redis Documentation: VLINKS

vrandmember

public Command<K,V,V> vrandmember(K key)

Create a new VRANDMEMBER command to get a random element from a vector set.

Parameters:

key - the key of the vector set, must not be null

Returns:

a new Command that returns a random element from the vector set

See Also:

Redis Documentation: VRANDMEMBER

vrandmember

public Command<K,V,List<V>> vrandmember(K key,
                                        int count)

Create a new VRANDMEMBER command to get multiple random elements from a vector set.

Parameters:

key - the key of the vector set, must not be null

count - the number of random elements to return

Returns:

a new Command that returns a list of random elements from the vector set

See Also:

Redis Documentation: VRANDMEMBER

vrem

public Command<K,V,Boolean> vrem(K key,
                                 V element)

Create a new VREM command to remove an element from a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element to remove from the vector set, must not be null

Returns:

a new Command that returns true if the element was removed, false if the key or element does not exist

See Also:

Redis Documentation: VREM

vsetattr

public Command<K,V,Boolean> vsetattr(K key,
                                     V element,
                                     String json)

Create a new VSETATTR command to set or update the attributes for an element in a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

json - the attributes as a JSON string, must not be null

Returns:

a new Command that returns true if the attributes were set, false if the key or element does not exist

See Also:

Redis Documentation: VSETATTR

vsetattr

public Command<K,V,Boolean> vsetattr(K key,
                                     V element,
                                     JsonValue json)

Create a new VSETATTR command to set or update the attributes for an element in a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element in the vector set, must not be null

json - the attributes as a JSON string, must not be null

Returns:

a new Command that returns true if the attributes were set, false if the key or element does not exist

See Also:

Redis Documentation: VSETATTR

vsim

public Command<K,V,List<V>> vsim(K key,
                                 Double[] vectors)

Create a new VSIM command to find the most similar vectors to the given query vector in a vector set.

Parameters:

key - the key of the vector set, must not be null

vectors - the query vector values as floating point numbers, must not be empty

Returns:

a new Command that returns a list of elements most similar to the query vector

See Also:

Redis Documentation: VSIM

vsim

public Command<K,V,List<V>> vsim(K key,
                                 V element)

Create a new VSIM command to find the most similar vectors to the given element's vector in a vector set.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element whose vector will be used as the query, must not be null

Returns:

a new Command that returns a list of elements most similar to the specified element

See Also:

Redis Documentation: VSIM

vsim

public Command<K,V,List<V>> vsim(K key,
                                 VSimArgs vSimArgs,
                                 Double[] vectors)

Create a new VSIM command to find the most similar vectors to the given query vector in a vector set with additional options.

Parameters:

key - the key of the vector set, must not be null

vSimArgs - the additional arguments for the VSIM command

vectors - the query vector values as floating point numbers, must not be empty

Returns:

a new Command that returns a list of elements most similar to the query vector

See Also:

Redis Documentation: VSIM

vsim

public Command<K,V,List<V>> vsim(K key,
                                 VSimArgs vSimArgs,
                                 V element)

Create a new VSIM command to find the most similar vectors to the given element's vector in a vector set with additional options.

Parameters:

key - the key of the vector set, must not be null

vSimArgs - the additional arguments for the VSIM command

element - the name of the element whose vector will be used as the query, must not be null

Returns:

a new Command that returns a list of elements most similar to the specified element

See Also:

Redis Documentation: VSIM

vsimWithScore

public Command<K,V,Map<V,Double>> vsimWithScore(K key,
                                                Double[] vectors)

Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given query vector and return them with their similarity scores.

Parameters:

key - the key of the vector set, must not be null

vectors - the query vector values as floating point numbers, must not be empty

Returns:

a new Command that returns a map of elements to their similarity scores

See Also:

Redis Documentation: VSIM

vsimWithScore

public Command<K,V,Map<V,Double>> vsimWithScore(K key,
                                                V element)

Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given element's vector and return them with their similarity scores.

Parameters:

key - the key of the vector set, must not be null

element - the name of the element whose vector will be used as the query, must not be null

Returns:

a new Command that returns a map of elements to their similarity scores

See Also:

Redis Documentation: VSIM

vsimWithScore

public Command<K,V,Map<V,Double>> vsimWithScore(K key,
                                                VSimArgs vSimArgs,
                                                Double[] vectors)

Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given query vector with additional options and return them with their similarity scores.

Parameters:

key - the key of the vector set, must not be null

vSimArgs - the additional arguments for the VSIM command

vectors - the query vector values as floating point numbers, must not be empty

Returns:

a new Command that returns a map of elements to their similarity scores

See Also:

Redis Documentation: VSIM

vsimWithScore

public Command<K,V,Map<V,Double>> vsimWithScore(K key,
                                                VSimArgs vSimArgs,
                                                V element)

Create a new VSIM command with the WITHSCORES option to find the most similar vectors to the given element's vector with additional options and return them with their similarity scores.

Parameters:

key - the key of the vector set, must not be null

vSimArgs - the additional arguments for the VSIM command

element - the name of the element whose vector will be used as the query, must not be null

Returns:

a new Command that returns a map of elements to their similarity scores

See Also:

Redis Documentation: VSIM