io.lettuce.core.search.arguments

Class SugAddArgs

java.lang.Object

io.lettuce.core.search.arguments.SugAddArgs

public class SugAddArgs
extends Object

Arguments for the FT.SUGADD command.

This class provides a builder pattern for constructing arguments for adding suggestions to an auto-complete dictionary. The FT.SUGADD command adds a suggestion string to an auto-complete suggestion dictionary with a specified score.

Since:

6.8

Author:

Tihomir Mateev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SugAddArgs.Builder Builder entry points for SugAddArgs.

Constructor Summary

Constructors

Constructor and Description
SugAddArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Builds the arguments and appends them to the CommandArgs.
SugAddArgs	incr() Increment the existing entry of the suggestion by the given score, instead of replacing the score.
SugAddArgs	payload(String payload) Deprecated. since 7.8, there is no replacement. The PAYLOAD argument of FT.SUGADD is deprecated by Redis since RediSearch 2.0.0.

Methods inherited from class java.lang.Object

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

Constructor Detail

SugAddArgs

public SugAddArgs()

Method Detail

incr

public SugAddArgs incr()

Increment the existing entry of the suggestion by the given score, instead of replacing the score. This is useful for updating the dictionary based on user queries in real time.

Returns:

this SugAddArgs.

payload

@Deprecated
public SugAddArgs payload(String payload)

Deprecated. since 7.8, there is no replacement. The PAYLOAD argument of FT.SUGADD is deprecated by Redis since RediSearch 2.0.0.

Save an extra payload with the suggestion, that can be fetched by adding the WITHPAYLOADS argument to FT.SUGGET.

Parameters:

payload - the payload to save with the suggestion.

Returns:

this SugAddArgs.

build

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

Builds the arguments and appends them to the CommandArgs.

Parameters:

args - the command arguments to append to.