io.lettuce.core.search.arguments.hybrid

Class HybridArgs.Builder<K,V>

java.lang.Object

io.lettuce.core.search.arguments.hybrid.HybridArgs.Builder<K,V>

Enclosing class:

HybridArgs<K,V>

public static class HybridArgs.Builder<K,V>
extends Object

Builder for HybridArgs.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HybridArgs<K,V>	build() Build the HybridArgs instance.
HybridArgs.Builder<K,V>	combine(Combiner<K> combiner) Configure the COMBINE clause using a Combiner.
HybridArgs.Builder<K,V>	param(K name, byte[] value) Add a binary parameter for parameterized queries.
HybridArgs.Builder<K,V>	param(K name, V value) Add a parameter for parameterized queries.
HybridArgs.Builder<K,V>	postProcessing(PostProcessingArgs<K,V> postProcessingArgs) Set the post-processing arguments.
HybridArgs.Builder<K,V>	search(HybridSearchArgs<K,V> searchArgs) Configure the SEARCH clause using HybridSearchArgs.
HybridArgs.Builder<K,V>	timeout(Duration timeout) Set the maximum time to wait for the query to complete.
HybridArgs.Builder<K,V>	vectorSearch(HybridVectorArgs<K,V> vectorArgs) Configure the VSIM clause using HybridVectorArgs.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public HybridArgs<K,V> build()

Build the HybridArgs instance.

Returns:

the configured arguments

search

public HybridArgs.Builder<K,V> search(HybridSearchArgs<K,V> searchArgs)

Configure the SEARCH clause using HybridSearchArgs.

Parameters:

searchArgs - the search arguments

Returns:

this builder

vectorSearch

public HybridArgs.Builder<K,V> vectorSearch(HybridVectorArgs<K,V> vectorArgs)

Configure the VSIM clause using HybridVectorArgs.

Parameters:

vectorArgs - the vector search arguments

Returns:

this builder

combine

public HybridArgs.Builder<K,V> combine(Combiner<K> combiner)

Configure the COMBINE clause using a Combiner.

Use Combiners.rrf() or Combiners.linear() to create combiners.

Parameters:

combiner - the combiner (use Combiners factory)

Returns:

this builder

See Also:

Combiners

postProcessing

public HybridArgs.Builder<K,V> postProcessing(PostProcessingArgs<K,V> postProcessingArgs)

Set the post-processing arguments.

Parameters:

postProcessingArgs - the post-processing configuration

Returns:

this builder

param

public HybridArgs.Builder<K,V> param(K name,
                                     V value)

Add a parameter for parameterized queries.

Parameters can be referenced in queries using $name syntax.

Parameters:

name - the parameter name

value - the parameter value

Returns:

this builder

param

public HybridArgs.Builder<K,V> param(K name,
                                     byte[] value)

Add a binary parameter for parameterized queries.

Use this for vector data that needs to be passed as binary. Parameters can be referenced in queries using $name syntax.

Parameters:

name - the parameter name

value - the binary parameter value (e.g., vector data)

Returns:

this builder

timeout

public HybridArgs.Builder<K,V> timeout(Duration timeout)

Set the maximum time to wait for the query to complete.

Parameters:

timeout - the timeout duration (with millisecond resolution)

Returns:

this builder