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.SUGADD

Syntax text Syntax diagram API methods

FT.SUGADD key string score [INCR] [PAYLOAD payload]

Client:

sugadd(
    key: str,  // The suggestion dictionary key
    suggestions: *Suggestion  // Suggestions to add
) → int  // The current size of the suggestion dictionary

Possible errors

WRONGTYPE: ResponseError

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

client.ft.sugAdd(
    key: RedisArgument,  // The suggestion dictionary key
    string: RedisArgument,  // The suggestion string
    score: number,  // The suggestion score
    options: { INCR?: boolean, PAYLOAD?: RedisArgument }  // Optional add options
) → number  // The current size of the suggestion dictionary

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.

ftSugAdd(
    key: String,  // The suggestion dictionary key
    string: String,  // The suggestion string
    score: double  // The suggestion score
) → long  // The current size of the suggestion dictionary

ftSugAddIncr(
    key: String,  // The suggestion dictionary key
    string: String,  // The suggestion string
    score: double  // The suggestion score
) → long  // The current size of the suggestion dictionary

Possible errors

WRONGTYPE: JedisDataException

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

ftSugadd(
    key: K,  // the suggestion dictionary key
    suggestion: String,  // the suggestion string to index
    score: double  // the floating point number of the suggestion string's weight
) → Long  // the current size of the suggestion dictionary after adding the suggestion

ftSugadd(
    key: K,  // the suggestion dictionary key
    suggestion: String,  // the suggestion string to index
    score: double,  // the floating point number of the suggestion string's weight
    args: SugAddArgs  // the suggestion add arguments (INCR, deprecated PAYLOAD)
) → Long  // the current size of the suggestion dictionary after adding the suggestion

Possible errors

WRONGTYPE: RedisCommandExecutionException

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

ftSugadd(
    key: K,  // the suggestion dictionary key
    suggestion: String,  // the suggestion string to index
    score: double  // the floating point number of the suggestion string's weight
) → RedisFuture<Long>  // the current size of the suggestion dictionary after adding the suggestion

ftSugadd(
    key: K,  // the suggestion dictionary key
    suggestion: String,  // the suggestion string to index
    score: double,  // the floating point number of the suggestion string's weight
    args: SugAddArgs  // the suggestion add arguments (INCR, deprecated PAYLOAD)
) → RedisFuture<Long>  // the current size of the suggestion dictionary after adding the suggestion

Possible errors

WRONGTYPE: RedisCommandExecutionException

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

ftSugadd(
    key: K,  // the suggestion dictionary key
    suggestion: String,  // the suggestion string to index
    score: double  // the floating point number of the suggestion string's weight
) → Mono<Long>  // the current size of the suggestion dictionary after adding the suggestion

ftSugadd(
    key: K,  // the suggestion dictionary key
    suggestion: String,  // the suggestion string to index
    score: double,  // the floating point number of the suggestion string's weight
    args: SugAddArgs  // the suggestion add arguments (INCR, deprecated PAYLOAD)
) → Mono<Long>  // the current size of the suggestion dictionary after adding the suggestion

Possible errors

WRONGTYPE: RedisCommandExecutionException

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

FTSugAdd(
    ctx: context.Context,
    key: string,  // The suggestion dictionary key
    suggestion: string,  // The suggestion string
    score: float64  // The suggestion score
) → *IntCmd  // The current size of the suggestion dictionary

FTSugAddWithArgs(
    ctx: context.Context,
    key: string,  // The suggestion dictionary key
    suggestion: string,  // The suggestion string
    score: float64,  // The suggestion score
    options: *FTSugAddOptions  // Add options
) → *IntCmd  // The current size of the suggestion dictionary

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.

SugAdd(
    key: string,  // The suggestion dictionary key
    str: string,  // The suggestion string
    score: double,  // The suggestion score
    increment: bool,  // Whether to increment the score if the suggestion exists
    payload: string?  // Optional payload
) → long  // The current size of the suggestion dictionary

Possible errors

WRONGTYPE: RedisServerException

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

SugAddAsync(
    key: string,  // The suggestion dictionary key
    str: string,  // The suggestion string
    score: double,  // The suggestion score
    increment: bool,  // Whether to increment the score if the suggestion exists
    payload: string?  // Optional payload
) → Task<long>  // The current size of the suggestion dictionary

Possible errors

WRONGTYPE: RedisServerException

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

ftsugadd(
    $key: string,  // The suggestion dictionary key
    $string: string,  // The suggestion string
    $score: float,  // The suggestion score
    $arguments: ?SugAddArguments  // Optional arguments (INCR, PAYLOAD)
) → int  // The current size of the suggestion dictionary

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_sugadd(
    key: String,  // the suggestion dictionary key
    string: String,  // the suggestion text
    score: Numeric,  // the suggestion weight
    options: Hash  // accepts :incr (increment the existing score, INCR) and :payload (opaque payload, PAYLOAD)
) → Integer  // the current size of the suggestion dictionary

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, @write,
Compatibility:: Redis Software and Redis Cloud compatibility

Add a suggestion string to an auto-complete suggestion dictionary

Required arguments

key

is suggestion dictionary key.

string

is suggestion string to index.

score

is floating point number of the suggestion string's weight.

The auto-complete suggestion dictionary is disconnected from the index definitions and leaves creating and updating suggestions dictionaries to the user.

Optional arguments

INCR

increments 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.

PAYLOAD {payload}

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

Examples

Add a suggestion string to an auto-complete suggestion dictionary

127.0.0.1:6379> FT.SUGADD sug "hello world" 1
(integer) 3

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

Integer reply: number of elements added to the suggestion dictionary.

See also

FT.SUGGET | FT.SUGDEL | FT.SUGLEN

History

Starting with Redis version 2.0.0: Deprecated PAYLOAD argument