FT.SUGGET

Get completion suggestions for a prefix

Required arguments

<details open> <summary><code>key</code></summary>

is suggestion dictionary key.

</details> <details open> <summary><code>prefix</code></summary>

is prefix to complete on.

</details>

Optional arguments

<details open> <summary><code>FUZZY</code></summary>

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

</details> <details open> <summary><code>MAX num</code></summary>

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

</details> <details open> <summary><code>WITHSCORES</code></summary>

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

</details> <details open> <summary><code>WITHPAYLOADS</code></summary>

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

</details>

Return

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

Example

<details open> <summary><b>Get completion suggestions for a prefix</b></summary>

{{< highlight bash >}} 127.0.0.1:6379> FT.SUGGET sug hell FUZZY MAX 3 WITHSCORES

1. "hell"
2. "2147483648"
3. "hello"
4. "0.70710676908493042" {{< / highlight >}}

</details>

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | <span title="Not supported">❌ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | Not supported on clustered databases. |

Return information

{{< multitabs id="ft-sugget-return-info" tab1="RESP2" tab2="RESP3" >}}

[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of the top suggestions matching the prefix, optionally with a score after each entry.

-tab-sep-

[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of the top suggestions matching the prefix, optionally with a score after each entry.

{{< /multitabs >}}

See also

[FT.SUGADD]({{< relref "commands/ft.sugadd/" >}}) | [FT.SUGDEL]({{< relref "commands/ft.sugdel/" >}}) | [FT.SUGLEN]({{< relref "commands/ft.suglen/" >}})

Related topics

[RediSearch]({{< relref "/develop/ai/search-and-query/" >}})