io.lettuce.core.search.arguments

Class SugGetArgs

java.lang.Object

io.lettuce.core.search.arguments.SugGetArgs

public class SugGetArgs
extends Object

Arguments for the FT.SUGGET command.

This class provides a builder pattern for constructing arguments for getting completion suggestions from an auto-complete dictionary. The FT.SUGGET command retrieves completion suggestions for a prefix from an auto-complete suggestion dictionary.

Since:

6.8

Author:

Tihomir Mateev

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SugGetArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Builds the arguments and appends them to the CommandArgs.
SugGetArgs	fuzzy() Perform a fuzzy prefix search, including prefixes at Levenshtein distance of 1 from the prefix sent.
boolean	isWithPayloads() Check if WITHPAYLOADS option is enabled.
boolean	isWithScores() Check if WITHSCORES option is enabled.
SugGetArgs	max(long max) Limit the results to a maximum of max suggestions (default: 5).
SugGetArgs	withPayloads() Deprecated. since 7.8, there is no replacement. The WITHPAYLOADS argument of FT.SUGGET is deprecated by Redis since RediSearch 2.0.0.
SugGetArgs	withScores() Also return the score of each suggestion.

Methods inherited from class java.lang.Object

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

Constructor Detail

SugGetArgs

public SugGetArgs()

Method Detail

fuzzy

public SugGetArgs fuzzy()

Perform a fuzzy prefix search, including prefixes at Levenshtein distance of 1 from the prefix sent.

Returns:

this SugGetArgs.

withScores

public SugGetArgs withScores()

Also return the score of each suggestion. This can be used to merge results from multiple instances.

Returns:

this SugGetArgs.

withPayloads

@Deprecated
public SugGetArgs withPayloads()

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

Return optional payloads saved along with the suggestions. If no payload is present for an entry, it returns a null reply.

Returns:

this SugGetArgs.

max

public SugGetArgs max(long max)

Limit the results to a maximum of max suggestions (default: 5).

Parameters:

max - the maximum number of suggestions to return.

Returns:

this SugGetArgs.

isWithScores

public boolean isWithScores()

Check if WITHSCORES option is enabled.

Returns:

true if WITHSCORES is enabled

isWithPayloads

public boolean isWithPayloads()

Check if WITHPAYLOADS option is enabled.

Returns:

true if WITHPAYLOADS is enabled

build

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

Builds the arguments and appends them to the CommandArgs.

Parameters:

args - the command arguments to append to.