redis.clients.jedis.params

Class VSimParams

java.lang.Object

redis.clients.jedis.params.VSimParams

All Implemented Interfaces:

IParams

@Experimental
public class VSimParams
extends java.lang.Object
implements IParams

Parameters for the VSIM command.

Constructor Summary

Constructors

Constructor and Description
VSimParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
VSimParams	count(int num) Limits the number of returned results.
VSimParams	ef(int searchExplorationFactor) Controls the search effort.
VSimParams	epsilon(double delta) Sets the epsilon (delta) parameter for distance-based filtering.
VSimParams	filter(java.lang.String expression) Applies a filter expression to restrict matching elements.
VSimParams	filterEf(int maxFilteringEffort) Limits the number of filtering attempts for the FILTER expression.
VSimParams	noThread() Executes the search in the main thread instead of a background thread.
VSimParams	truth() Forces an exact linear scan of all elements, bypassing the HNSW graph.

Methods inherited from class java.lang.Object

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

Constructor Detail

VSimParams

public VSimParams()

Method Detail

count

public VSimParams count(int num)

Limits the number of returned results.

Parameters:

num - the maximum number of results to return

Returns:

VSimParams

epsilon

public VSimParams epsilon(double delta)

Sets the epsilon (delta) parameter for distance-based filtering. Only elements with a similarity score of (1 - epsilon) or better are returned. For example, epsilon=0.2 means only elements with similarity >= 0.8 are returned.

Parameters:

delta - a floating point number between 0 and 1

Returns:

VSimParams

ef

public VSimParams ef(int searchExplorationFactor)

Controls the search effort. Higher values explore more nodes, improving recall at the cost of speed. Typical values range from 50 to 1000.

Parameters:

searchExplorationFactor - the exploration factor

Returns:

VSimParams

filter

public VSimParams filter(java.lang.String expression)

Applies a filter expression to restrict matching elements.

Parameters:

expression - the filter expression

Returns:

VSimParams

filterEf

public VSimParams filterEf(int maxFilteringEffort)

Limits the number of filtering attempts for the FILTER expression.

Parameters:

maxFilteringEffort - the maximum filtering effort

Returns:

VSimParams

truth

public VSimParams truth()

Forces an exact linear scan of all elements, bypassing the HNSW graph. Use for benchmarking or to calculate recall. This is significantly slower (O(N)).

Returns:

VSimParams

noThread

public VSimParams noThread()

Executes the search in the main thread instead of a background thread. Useful for small vector sets or benchmarks. This may block the server during execution.

Returns:

VSimParams

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams