io.lettuce.core.search.arguments.hybrid

Class HybridVectorArgs.Builder

java.lang.Object

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

Enclosing class:

HybridVectorArgs

public static class HybridVectorArgs.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HybridVectorArgs	build() Build the HybridVectorArgs instance.
HybridVectorArgs.Builder	field(String fieldName) Set the vector field name.
HybridVectorArgs.Builder	filter(String expression) Add a FILTER expression for pre-filtering documents before vector scoring.
HybridVectorArgs.Builder	method(HybridVectorArgs.VectorSearchMethod method) Set the vector search method (KNN or RANGE).
HybridVectorArgs.Builder	scoreAlias(String alias) Set an alias for the vector distance field (normalized vector score).
HybridVectorArgs.Builder	vector(String vectorData) Set the query vector parameter reference.

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

field

public HybridVectorArgs.Builder field(String fieldName)

Set the vector field name.

Parameters:

fieldName - the field name (typically prefixed with '@')

Returns:

this builder

vector

public HybridVectorArgs.Builder vector(String vectorData)

Set the query vector parameter reference.

This should be a parameter name (e.g., "$vec") that references a vector passed via HybridArgs.Builder.param(String, byte[]). The actual binary vector data must be provided in PARAMS.

Parameters:

vectorData - the parameter reference (e.g., "$vec")

Returns:

this builder

method

public HybridVectorArgs.Builder method(HybridVectorArgs.VectorSearchMethod method)

Set the vector search method (KNN or RANGE).

Parameters:

method - the search method

Returns:

this builder

See Also:

HybridVectorArgs.Knn, HybridVectorArgs.Range

filter

public HybridVectorArgs.Builder filter(String expression)

Add a FILTER expression for pre-filtering documents before vector scoring.

Parameters:

expression - the filter expression (e.g., "@brand:{apple|samsung}")

Returns:

this builder

scoreAlias

public HybridVectorArgs.Builder scoreAlias(String alias)

Set an alias for the vector distance field (normalized vector score).

Parameters:

alias - the field name to use for the normalized vector distance

Returns:

this builder

build

public HybridVectorArgs build()

Build the HybridVectorArgs instance.

Returns:

the configured arguments