Redis Iris

Redis install Data types

Tools Community Docs

Login Sign up

Develop with Redis Libraries and tools Redis products

Commands

Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

FT.SUGGET

Syntax text Syntax diagram API methods

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

Client:

sugget(
    key: str,  // The suggestion dictionary key
    prefix: str,  // The prefix to search for
    fuzzy: bool,  // Whether to use fuzzy matching
    num: int,  // Maximum number of suggestions to return
    with_scores: bool,  // Whether to include scores
    with_payloads: bool  // Whether to include payloads
) → List[Union[str, Tuple]]  // List of suggestions

Possible errors

WRONGTYPE: ResponseError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

client.ft.sugGet(
    key: RedisArgument,  // The suggestion dictionary key
    prefix: RedisArgument,  // The prefix to search for
    options: FTSugGetOptions  // Optional get options
) → Array<string> | Array<FTSuggestion>  // List of suggestions

Possible errors

WRONGTYPE: SimpleError (test with err.message.startsWith('WRONGTYPE'))

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

ftSugGet(
    key: String,  // The suggestion dictionary key
    prefix: String  // The prefix to search for
) → List<String>  // List of suggestions

ftSugGetWithScores(
    key: String,  // The suggestion dictionary key
    prefix: String,  // The prefix to search for
    max: int  // Maximum number of suggestions
) → List<Suggestion>  // List of suggestions with scores

Possible errors

WRONGTYPE: JedisDataException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

ftSugget(
    key: K,  // the suggestion dictionary key
    prefix: String  // the prefix to complete on
) → List<Suggestion>  // a list of suggestions matching the prefix

ftSugget(
    key: K,  // the suggestion dictionary key
    prefix: String,  // the prefix to complete on
    args: SugGetArgs  // the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)
) → List<Suggestion>  // a list of suggestions matching the prefix, optionally with scores and payloads

Possible errors

WRONGTYPE: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

ftSugget(
    key: K,  // the suggestion dictionary key
    prefix: String  // the prefix to complete on
) → RedisFuture<List<Suggestion>>  // a list of suggestions matching the prefix

ftSugget(
    key: K,  // the suggestion dictionary key
    prefix: String,  // the prefix to complete on
    args: SugGetArgs  // the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)
) → RedisFuture<List<Suggestion>>  // a list of suggestions matching the prefix, optionally with scores and payloads

Possible errors

WRONGTYPE: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

ftSugget(
    key: K,  // the suggestion dictionary key
    prefix: String  // the prefix to complete on
) → Flux<Suggestion>  // a list of suggestions matching the prefix

ftSugget(
    key: K,  // the suggestion dictionary key
    prefix: String,  // the prefix to complete on
    args: SugGetArgs  // the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)
) → Flux<Suggestion>  // a list of suggestions matching the prefix, optionally with scores and payloads

Possible errors

WRONGTYPE: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

FTSugGet(
    ctx: context.Context,
    key: string,  // The suggestion dictionary key
    prefix: string  // The prefix to search for
) → *StringSliceCmd  // List of suggestions

FTSugGetWithArgs(
    ctx: context.Context,
    key: string,  // The suggestion dictionary key
    prefix: string,  // The prefix to search for
    options: *FTSugGetOptions  // Get options
) → *FTSugGetCmd  // List of suggestions

Possible errors

WRONGTYPE: redis.Error (test with redis.HasErrorPrefix(err, "WRONGTYPE"))

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

SugGet(
    key: string,  // The suggestion dictionary key
    prefix: string,  // The prefix to search for
    fuzzy: bool,  // Whether to use fuzzy matching
    withPayloads: bool,  // Whether to return payloads
    max: int?  // Maximum number of suggestions to return
) → List<string>  // List of suggestions

SugGetWithScores(
    key: string,  // The suggestion dictionary key
    prefix: string,  // The prefix to search for
    fuzzy: bool,  // Whether to use fuzzy matching
    withPayloads: bool,  // Whether to return payloads
    max: int?  // Maximum number of suggestions to return
) → List<Tuple<string, double>>  // List of suggestions with scores

Possible errors

WRONGTYPE: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

SugGetAsync(
    key: string,  // The suggestion dictionary key
    prefix: string,  // The prefix to search for
    fuzzy: bool,  // Whether to use fuzzy matching
    withPayloads: bool,  // Whether to return payloads
    max: int?  // Maximum number of suggestions to return
) → Task<List<string>>  // List of suggestions

SugGetWithScoresAsync(
    key: string,  // The suggestion dictionary key
    prefix: string,  // The prefix to search for
    fuzzy: bool,  // Whether to use fuzzy matching
    withPayloads: bool,  // Whether to return payloads
    max: int?  // Maximum number of suggestions to return
) → Task<List<Tuple<string, double>>>  // List of suggestions with scores

Possible errors

WRONGTYPE: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

ftsugget(
    $key: string,  // The suggestion dictionary key
    $prefix: string,  // The prefix to search for
    $arguments: ?SugGetArguments  // Optional arguments (FUZZY, WITHSCORES, WITHPAYLOADS, MAX)
) → array  // List of suggestions

Possible errors

WRONGTYPE: Predis\Response\ServerException (test with $e->getErrorType() === 'WRONGTYPE')

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

ft_sugget(
    key: String,  // the suggestion dictionary key
    prefix: String,  // the prefix to complete
    options: Hash  // accepts :fuzzy (FUZZY), :with_scores (WITHSCORES), :with_payloads (WITHPAYLOADS) and :max (MAX)
) → Array<String>  // the suggestions, interleaved with scores/payloads when requested

Possible errors

WRONGTYPE: Redis::WrongTypeError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

Available in:: Redis Open Source / Search 1.0.0
Time complexity:: O(1)
ACL categories:: @search,
Compatibility:: Redis Software and Redis Cloud compatibility

Get completion suggestions for a prefix

Required arguments

key

is suggestion dictionary key.

prefix

is prefix to complete on.

Optional arguments

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.

WITHPAYLOADS

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

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"

Redis Software and Redis Cloud compatibility

Redis Software	Redis Software Flex	Redis Cloud	Notes
✅ Standard ❌ Active-Active	❌ Not supported	❌ Standard ❌ Active-Active	Not supported on clustered databases.

Return information

RESP2 RESP3

Array of the top suggestions matching the prefix, optionally with a score after each entry.

See also

FT.SUGADD | FT.SUGDEL | FT.SUGLEN

History

Starting with Redis version 2.0.0: Deprecated WITHPAYLOADS argument