{
  "schema_version": 2,
  "id": "commands/ft.sugget",
  "title": "FT.SUGGET",
  "url": "https://redis.io/docs/latest/commands/ft.sugget/",
  "summary": "Gets completion suggestions for a prefix",
  "since": "1.0.0",
  "tags": [
    "docs",
    "develop",
    "stack",
    "oss",
    "rs",
    "rc",
    "oss",
    "kubernetes",
    "clients"
  ],
  "last_updated": "2026-09-18T09:47:58+01:00",
  "page_type": "content",
  "content_hash": "d62651b5d70a06ea1e7eaecd8001dae7aba7ae0ab9590ab091be70ae260d193e",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Get completion suggestions for a prefix"
    },
    {
      "id": "required-arguments",
      "title": "Required arguments",
      "role": "content",
      "text": "<details open>\n<summary><code>key</code></summary>\n\nis suggestion dictionary key.\n</details>\n\n<details open>\n<summary><code>prefix</code></summary>\n\nis prefix to complete on.\n</details>"
    },
    {
      "id": "optional-arguments",
      "title": "Optional arguments",
      "role": "parameters",
      "text": "<details open>\n<summary><code>FUZZY</code></summary> \n\nperforms a fuzzy prefix search, including prefixes at Levenshtein distance of 1 from the prefix sent.\n</details>\n\n<details open>\n<summary><code>MAX num</code></summary> \n\nlimits the results to a maximum of `num` (default: 5).\n</details>\n\n<details open>\n<summary><code>WITHSCORES</code></summary> \n\nalso returns the score of each suggestion. This can be used to merge results from multiple instances.\n</details>\n\n<details open>\n<summary><code>WITHPAYLOADS</code></summary> \n\nreturns optional payloads saved along with the suggestions. If no payload is present for an entry, it returns a null reply.\n</details>"
    },
    {
      "id": "examples",
      "title": "Examples",
      "role": "example",
      "text": "<details open>\n<summary><b>Get completion suggestions for a prefix</b></summary>\n\n\n127.0.0.1:6379> FT.SUGGET sug hell FUZZY MAX 3 WITHSCORES\n1) \"hell\"\n2) \"2147483648\"\n3) \"hello\"\n4) \"0.70710676908493042\"\n\n</details>"
    },
    {
      "id": "redis-software-and-redis-cloud-compatibility",
      "title": "Redis Software and Redis Cloud compatibility",
      "role": "content",
      "text": "| Redis<br />Software | Redis<br />Cloud | <span style=\"min-width: 9em; display: table-cell\">Notes</span> |\n|:----------------------|:-----------------|:------|\n| <span title=\"Supported\">&#x2705; Standard</span><br /><span title=\"Not supported\"><nobr>&#x274c; Active-Active</nobr></span> | <span title=\"Not supported\">&#x274c; Standard</span><br /><span title=\"Not supported\"><nobr>&#x274c; Active-Active</nobr></span> | Not supported on clustered databases. |"
    },
    {
      "id": "return-information",
      "title": "Return information",
      "role": "returns",
      "text": "**RESP2:**\n\n[Array](https://redis.io/docs/latest/develop/reference/protocol-spec#arrays) of the top suggestions matching the prefix, optionally with a score after each entry.\n\n**RESP3:**\n\n[Array](https://redis.io/docs/latest/develop/reference/protocol-spec#arrays) of the top suggestions matching the prefix, optionally with a score after each entry."
    },
    {
      "id": "see-also",
      "title": "See also",
      "role": "related",
      "text": "[`FT.SUGADD`](https://redis.io/docs/latest/commands/ft.sugadd) | [`FT.SUGDEL`](https://redis.io/docs/latest/commands/ft.sugdel) | [`FT.SUGLEN`](https://redis.io/docs/latest/commands/ft.suglen)"
    },
    {
      "id": "related-topics",
      "title": "Related topics",
      "role": "related",
      "text": "[RediSearch](https://redis.io/docs/latest/develop/ai/search-and-query)"
    }
  ],
  "examples": []
}