io.lettuce.core.search.arguments

Class CombineArgs.RRF<K>

java.lang.Object

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

Type Parameters:

K - Key type

All Implemented Interfaces:

CombineArgs.CombineMethod<K>

Enclosing class:

CombineArgs<K>

public static class CombineArgs.RRF<K>
extends Object
implements CombineArgs.CombineMethod<K>

Reciprocal Rank Fusion (RRF) combine method. Combines rankings from text and vector search using reciprocal rank fusion.

RRF formula: score = 1 / (CONSTANT + rank_in_window)

Constructor Summary

Constructors

Constructor and Description
RRF()

Method Summary

Modifier and Type	Method and Description
<V> void	build(CommandArgs<K,V> args) Build the combine method arguments.
CombineArgs.RRF<K>	constant(double constant) Set the CONSTANT parameter - constant added to rank to prevent division by zero.
CombineArgs.RRF<K>	window(int window) Set the WINDOW parameter - number of top results to consider from each ranking.

Methods inherited from class java.lang.Object

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

Constructor Detail

RRF

public RRF()

Method Detail

window

public CombineArgs.RRF<K> window(int window)

Set the WINDOW parameter - number of top results to consider from each ranking.

Parameters:

window - number of top results

Returns:

this instance

constant

public CombineArgs.RRF<K> constant(double constant)

Set the CONSTANT parameter - constant added to rank to prevent division by zero.

Parameters:

constant - constant value

Returns:

this instance

build

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

Description copied from interface: CombineArgs.CombineMethod

Build the combine method arguments.

Specified by:

build in interface CombineArgs.CombineMethod<K>

Type Parameters:

V - value type

Parameters:

args - the CommandArgs to append to