io.lettuce.core.search.arguments.hybrid

Class HybridArgs

java.lang.Object

io.lettuce.core.search.arguments.hybrid.HybridArgs

public class HybridArgs
extends Object

Argument list builder for the Redis FT.HYBRID command. Combines text search and vector similarity search with configurable combination strategies and post-processing operations.

Basic Usage:

 {
     @code
     HybridArgs args = HybridArgs
             .builder().search(HybridSearchArgs.builder().query("comfortable shoes").build()).vectorSearch(HybridVectorArgs
                     .builder().field("@embedding").vector("$vec").method(HybridVectorArgs.Knn.of(10)).build())
             .combine(Combiners.rrf().window(20).constant(60)).param("vec", vectorBlob).build();
 }
 

Since:

7.2

Author:

Aleksandar Todorov

See Also:

FT.HYBRID, HybridSearchArgs, HybridVectorArgs, Combiner, Combiners, PostProcessingArgs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HybridArgs.Builder Builder for HybridArgs.

Constructor Summary

Constructors

Constructor and Description
HybridArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Build the command arguments for the configured HybridArgs.
static HybridArgs.Builder	builder()

Methods inherited from class java.lang.Object

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

Constructor Detail

HybridArgs

public HybridArgs()

Method Detail

builder

public static HybridArgs.Builder builder()

Returns:

a new HybridArgs.Builder for HybridArgs.

build

public void build(CommandArgs<?,?> args)

Build the command arguments for the configured HybridArgs.

Command structure: SEARCH [SCORER] [YIELD_SCORE_AS] VSIM [KNN/RANGE] [FILTER]* [YIELD_DISTANCE_AS] [COMBINE] [YIELD_SCORE_AS] [SORTBY] [FILTER]* [LIMIT] [RETURN] [LOAD] [PARAMS]

Parameters:

args - the CommandArgs to append to