io.lettuce.core.search.arguments.hybrid

Class HybridArgs.Builder

java.lang.Object

io.lettuce.core.search.arguments.hybrid.HybridArgs.Builder

Enclosing class:

HybridArgs

public static class HybridArgs.Builder
extends Object

Builder for HybridArgs.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HybridArgs	build() Build the HybridArgs instance.
HybridArgs.Builder	combine(Combiner combiner) Configure the COMBINE clause using a Combiner.
HybridArgs.Builder	param(String name, byte[] value) Add a binary query parameter, for example the query vector of a KNN clause (*=>[KNN 10 @embedding $vec]).
HybridArgs.Builder	param(String name, String value) Add a query parameter.
HybridArgs.Builder	postProcessing(PostProcessingArgs postProcessingArgs) Set the post-processing arguments.
HybridArgs.Builder	search(HybridSearchArgs searchArgs) Configure the SEARCH clause using HybridSearchArgs.
HybridArgs.Builder	timeout(Duration timeout) Set the maximum time to wait for the query to complete.
HybridArgs.Builder	vectorSearch(HybridVectorArgs 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 build()

Build the HybridArgs instance.

Returns:

the configured arguments

search

public HybridArgs.Builder search(HybridSearchArgs searchArgs)

Configure the SEARCH clause using HybridSearchArgs.

Parameters:

searchArgs - the search arguments

Returns:

this builder

vectorSearch

public HybridArgs.Builder vectorSearch(HybridVectorArgs vectorArgs)

Configure the VSIM clause using HybridVectorArgs.

Parameters:

vectorArgs - the vector search arguments

Returns:

this builder

combine

public HybridArgs.Builder combine(Combiner 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 postProcessing(PostProcessingArgs postProcessingArgs)

Set the post-processing arguments.

Parameters:

postProcessingArgs - the post-processing configuration

Returns:

this builder

param

public HybridArgs.Builder param(String name,
                                String value)

Add a query parameter. The query references it as $name and the server substitutes the value wherever that reference appears, so values need no escaping and cannot alter the query structure, for example param("category", "electronics") with the query @category:{$category}. The value is sent as UTF-8 text. Adding a parameter with the same name again replaces its value.

FT.HYBRID always accepts parameters; the query vector of the VSIM clause is passed this way, as vector("$vec") together with param("vec", blob).

Parameters:

name - the parameter name, referenced as $name in the query, must not be null

value - the parameter value, must not be null

Returns:

this builder

param

public HybridArgs.Builder param(String name,
                                byte[] value)

Add a binary query parameter, for example the query vector of a KNN clause (*=>[KNN 10 @embedding $vec]). The bytes are sent exactly as given, which the String overload cannot do for arbitrary binary data. The query references the parameter as $name; adding a parameter with the same name again replaces its value.

FT.HYBRID always accepts parameters; the query vector of the VSIM clause is passed this way, as vector("$vec") together with param("vec", blob).

Parameters:

name - the parameter name, referenced as $name in the query, must not be null

value - the binary parameter value, sent as-is, must not be null

Returns:

this builder

Since:

7.8

timeout

public HybridArgs.Builder 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