io.lettuce.core

Class VSimArgs.Builder

java.lang.Object

io.lettuce.core.VSimArgs.Builder

Enclosing class:

VSimArgs

public static class VSimArgs.Builder
extends Object

Builder entry points for VSimArgs.

These static methods provide a convenient way to create new instances of VSimArgs with specific options set. Each method creates a new instance and sets the corresponding option.

Method Summary

Modifier and Type	Method and Description
static VSimArgs	count(Long count) Creates new VSimArgs and setting COUNT.
static VSimArgs	explorationFactor(Long explorationFactor) Creates new VSimArgs and setting EF.
static VSimArgs	filter(String filter) Creates new VSimArgs and setting FILTER.
static VSimArgs	filterEfficiency(Long filterEfficiency) Creates new VSimArgs and setting FILTER-EF.
static VSimArgs	noThread() Creates new VSimArgs and setting NOTHREAD.
static VSimArgs	truth() Creates new VSimArgs and setting TRUTH.

Methods inherited from class java.lang.Object

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

Method Detail

count

public static VSimArgs count(Long count)

Creates new VSimArgs and setting COUNT.

The COUNT option limits the number of returned results to the specified value.

Parameters:

count - the number of results to return.

Returns:

new VSimArgs with COUNT set.

See Also:

VSimArgs.count(Long)

explorationFactor

public static VSimArgs explorationFactor(Long explorationFactor)

Creates new VSimArgs and setting EF.

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.

Parameters:

explorationFactor - the exploration factor for the vector search.

Returns:

new VSimArgs with EF set.

See Also:

VSimArgs.explorationFactor(Long)

filter

public static VSimArgs filter(String filter)

Creates new VSimArgs and setting FILTER.

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

Parameters:

filter - the filter expression to apply.

Returns:

new VSimArgs with FILTER set.

See Also:

VSimArgs.filter(String), Filter expressions

filterEfficiency

public static VSimArgs filterEfficiency(Long filterEfficiency)

Creates new VSimArgs and setting FILTER-EF.

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.

Parameters:

filterEfficiency - the maximum filtering effort to use.

Returns:

new VSimArgs with FILTER-EF set.

See Also:

VSimArgs.filterEfficiency(Long), Filter expressions

truth

public static VSimArgs truth()

Creates new VSimArgs and setting TRUTH.

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)).

Returns:

new VSimArgs with TRUTH set.

See Also:

VSimArgs.truth()

noThread

public static VSimArgs noThread()

Creates new VSimArgs and setting NOTHREAD.

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.

Returns:

new VSimArgs with NOTHREAD set.

See Also:

VSimArgs.noThread()