FT.SUGGET

Available in:
Redis Stack / Search 1.0.0
Time complexity:
O(1)

Get completion suggestions for a prefix

Syntax

FT.SUGGET key prefix 
          [FUZZY] 
          [WITHSCORES] 
          [WITHPAYLOADS] 
          [MAX max]

Examples

Required parameters

key

is suggestion dictionary key.

prefix

is prefix to complete on.

Optional parameters

FUZZY

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

MAX num

limits the results to a maximum of num (default: 5).

WITHSCORES

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

WITHSCORES

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

Return

FT.SUGGET returns an array reply, which is a list of the top suggestions matching the prefix, optionally with score after each entry.

Examples

Get completion suggestions for a prefix
127.0.0.1:6379> FT.SUGGET sug hell FUZZY MAX 3 WITHSCORES
1) "hell"
2) "2147483648"
3) "hello"
4) "0.70710676908493042"

See also

FT.SUGADD | FT.SUGDEL | FT.SUGLEN

RediSearch

History

  • Starting with Redis version 2.0.0: Deprecated WITHPAYLOADS argument