io.lettuce.core.search.arguments

Class CombineArgs<K>

java.lang.Object

io.lettuce.core.search.arguments.CombineArgs<K>

Type Parameters:

K - Key type

@Experimental
public class CombineArgs<K>
extends Object

Arguments for the COMBINE clause in FT.HYBRID command. Defines how text search scores and vector similarity scores are combined into a final ranking score using RRF (Reciprocal Rank Fusion) or LINEAR strategies.

Since:

7.2

Author:

Aleksandar Todorov

See Also:

FT.HYBRID, CombineArgs.RRF, CombineArgs.Linear

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CombineArgs.CombineMethod<K> Interface for combine methods (RRF or LINEAR).
static class	CombineArgs.Linear<K> Linear combine method.
static class	CombineArgs.RRF<K> Reciprocal Rank Fusion (RRF) combine method.

Method Summary

Modifier and Type	Method and Description
CombineArgs<K>	as(K alias) Set an alias for the combined score field using YIELD_SCORE_AS.
<V> void	build(CommandArgs<K,V> args) Build the COMBINE clause arguments.
static <K> CombineArgs<K>	of(CombineArgs.CombineMethod<K> method) Create CombineArgs with the specified combine method.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <K> CombineArgs<K> of(CombineArgs.CombineMethod<K> method)

Create CombineArgs with the specified combine method.

Type Parameters:

K - Key type

Parameters:

method - the combine method (RRF or Linear)

Returns:

CombineArgs instance

as

public CombineArgs<K> as(K alias)

Set an alias for the combined score field using YIELD_SCORE_AS.

Parameters:

alias - the field name to use for the combined score

Returns:

this instance

build

public <V> void build(CommandArgs<K,V> args)

Build the COMBINE clause arguments.

Type Parameters:

V - value type

Parameters:

args - the CommandArgs to append to