io.lettuce.core.search.arguments.hybrid

Class Combiner<K>

java.lang.Object

io.lettuce.core.search.arguments.hybrid.Combiner<K>

Type Parameters:

K - Key type

Direct Known Subclasses:

Combiners.Linear, Combiners.RRF

@Experimental
public abstract class Combiner<K>
extends Object

Abstract combiner for combining multiple search scores in FT.HYBRID command. Instances are created via Combiners.

Combiners define how text search scores and vector similarity scores are combined into a final ranking score using RRF (Reciprocal Rank Fusion) or LINEAR strategies.

Example Usage:

 
 // RRF with default parameters
 Combiners.rrf()

 // RRF with custom window and constant
 Combiners.rrf().window(10).constant(60)

 // Linear combination with weights
 Combiners.linear().alpha(0.7).beta(0.3)

 // With score alias
 Combiners.rrf().as("combined_score")
 
 

Since:

7.5

Author:

Aleksandar Todorov

See Also:

Combiners, FT.HYBRID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Combiner(String name) Creates a new combiner with the specified name.

Method Summary

Modifier and Type	Method and Description
<T extends Combiner<K>> T	as(K alias) Set an alias for the combined score field using YIELD_SCORE_AS.
<V> void	build(CommandArgs<K,V> args) Build the combiner arguments into the command.
String	getName() Get the combiner name.
protected abstract List<Object>	getOwnArgs() Get the combiner-specific arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

Combiner

protected Combiner(String name)

Creates a new combiner with the specified name.

Parameters:

name - the combiner name (e.g., "RRF", "LINEAR")

Method Detail

getName

public final String getName()

Get the combiner name.

Returns:

the combiner name

as

public final <T extends Combiner<K>> T 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

getOwnArgs

protected abstract List<Object> getOwnArgs()

Get the combiner-specific arguments.

Returns:

list of combiner-specific arguments

build

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

Build the combiner arguments into the command.

Type Parameters:

V - value type

Parameters:

args - the CommandArgs to append to