redis.clients.jedis.search.hybrid

Class FTHybridVectorParams.Builder

java.lang.Object

redis.clients.jedis.search.hybrid.FTHybridVectorParams.Builder

Enclosing class:

FTHybridVectorParams

public static class FTHybridVectorParams.Builder
extends java.lang.Object

Builder for FTHybridVectorParams.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FTHybridVectorParams	build() Build the FTHybridVectorParams instance.
FTHybridVectorParams.Builder	field(java.lang.String field) Set the vector field name.
FTHybridVectorParams.Builder	filter(java.lang.String filter) Add a FILTER expression for pre-filtering documents before vector scoring.
FTHybridVectorParams.Builder	method(FTHybridVectorParams.VectorMethod method) Set the vector search method (KNN or RANGE).
FTHybridVectorParams.Builder	scoreAlias(java.lang.String scoreAlias) Set an alias for the vector distance score in the results.
FTHybridVectorParams.Builder	vector(java.lang.String vector) Set the param name to reference the query vector BLOB.

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 FTHybridVectorParams build()

Build the FTHybridVectorParams instance.

Returns:

the configured arguments

field

public FTHybridVectorParams.Builder field(java.lang.String field)

Set the vector field name.

Parameters:

field - the field name (e.g., "@embedding")

Returns:

this builder

vector

public FTHybridVectorParams.Builder vector(java.lang.String vector)

Set the param name to reference the query vector BLOB.

Parameters:

vector - the vector param name

Returns:

this builder

method

public FTHybridVectorParams.Builder method(FTHybridVectorParams.VectorMethod method)

Set the vector search method (KNN or RANGE).

Parameters:

method - the vector search method

Returns:

this builder

filter

public FTHybridVectorParams.Builder filter(java.lang.String filter)

Add a FILTER expression for pre-filtering documents before vector scoring. Can be called multiple times to add multiple filters.

Parameters:

filter - the filter expression

Returns:

this builder

scoreAlias

public FTHybridVectorParams.Builder scoreAlias(java.lang.String scoreAlias)

Set an alias for the vector distance score in the results.

Parameters:

scoreAlias - the score alias name

Returns:

this builder