io.lettuce.core

Class VSimArgs

java.lang.Object

io.lettuce.core.VSimArgs

All Implemented Interfaces:

CompositeArgument

public class VSimArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis VSIM command. Static import the methods from VSimArgs.Builder and call the methods: count(…) .

VSimArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

6.7

Author:

Tihomir Mateev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VSimArgs.Builder Builder entry points for VSimArgs.

Constructor Summary

Constructors

Constructor and Description
VSimArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
VSimArgs	count(Long count) Set the number of results to return.
VSimArgs	epsilon(double delta) Sets the EPSILON distance cutoff for approximate vector similarity matching; results must have similarity ≥ 1 − epsilon.
VSimArgs	explorationFactor(Long explorationFactor) Set the exploration factor for the vector search.
VSimArgs	filter(String filter) Set the filter expression to apply.
VSimArgs	filterEfficiency(Long filterEfficiency) Set the filter efficiency to use.
VSimArgs	noThread() Disable threading for the vector search.
VSimArgs	noThread(boolean noThread) Enable or disable threading for the vector search.
VSimArgs	truth() Enable truth mode for the vector search.
VSimArgs	truth(boolean truth) Enable or disable truth mode for the vector search.

Methods inherited from class java.lang.Object

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

Constructor Detail

VSimArgs

public VSimArgs()

Method Detail

count

public VSimArgs count(Long count)

Set the number of results to return.

The COUNT option limits the number of returned results to the specified value. This is useful when you only need a specific number of the most similar elements.

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

Parameters:

count - the number of results to return.

Returns:

this

explorationFactor

public VSimArgs explorationFactor(Long explorationFactor)

Set the exploration factor for the vector search.

The EF (exploration factor) option controls the search effort. Higher values explore more nodes, improving recall at the cost of speed. Typical values range from 50 to 1000.

Increasing this value will generally improve search quality but reduce performance.

Parameters:

explorationFactor - the exploration factor for the vector search.

Returns:

this

filter

public VSimArgs filter(String filter)

Set the filter expression to apply.

The FILTER option applies a filter expression to restrict matching elements. Filter expressions can be used to narrow down search results based on attributes associated with the vector elements.

For example, a filter like "price < 100" would only return elements with a price attribute less than 100.

Parameters:

filter - the filter expression to apply.

Returns:

this

filterEfficiency

public VSimArgs filterEfficiency(Long filterEfficiency)

Set the filter efficiency to use.

The FILTER-EF option limits the number of filtering attempts for the FILTER expression. This controls the maximum effort spent on filtering during the search process.

Higher values will spend more effort trying to find elements that match the filter, potentially improving recall for filtered searches at the cost of performance.

Parameters:

filterEfficiency - the maximum filtering effort to use.

Returns:

this

truth

public VSimArgs truth()

Enable truth mode for the vector search.

The TRUTH option forces an exact linear scan of all elements, bypassing the HNSW graph. This is useful for benchmarking or to calculate recall. Note that this is significantly slower with a time complexity of O(N) instead of O(log(N)).

This option is primarily intended for testing and evaluation purposes.

Returns:

this

truth

public VSimArgs truth(boolean truth)

Enable or disable truth mode for the vector search.

The TRUTH option forces an exact linear scan of all elements, bypassing the HNSW graph. This is useful for benchmarking or to calculate recall. Note that this is significantly slower with a time complexity of O(N) instead of O(log(N)).

This option is primarily intended for testing and evaluation purposes.

Parameters:

truth - whether to enable truth mode.

Returns:

this

noThread

public VSimArgs noThread()

Disable threading for the vector search.

The NOTHREAD option executes the search in the main thread instead of a background thread. This is useful for small vector sets or benchmarks, but may block the server during execution and increase server latency.

Use this option with caution in production environments.

Returns:

this

noThread

public VSimArgs noThread(boolean noThread)

Enable or disable threading for the vector search.

The NOTHREAD option executes the search in the main thread instead of a background thread. This is useful for small vector sets or benchmarks, but may block the server during execution and increase server latency.

Use this option with caution in production environments.

Parameters:

noThread - whether to disable threading.

Returns:

this

epsilon

public VSimArgs epsilon(double delta)

Sets the EPSILON distance cutoff for approximate vector similarity matching; results must have similarity ≥ 1 − epsilon. In other words, this is a maximum distance threshold used to filter VSIM results.

Parameters:

delta - the similarity threshold delta value, must be within [0.0, 1.0] inclusive

Returns:

this

Throws:

IllegalArgumentException - if delta is outside the valid range [0.0, 1.0]

build

public <K,V> void build(CommandArgs<K,V> args)

Description copied from interface: CompositeArgument

Build command arguments and contribute arguments to CommandArgs.

Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.

Specified by:

build in interface CompositeArgument

Type Parameters:

K - Key type.

V - Value type.

Parameters:

args - the command arguments, must not be null.