FT.SEARCH

is index name. You must first create the index using FT.CREATE.

is text query to search. If it's more than a single word, put it in quotes. Refer to Query syntax for more details.

returns the document ids and not the content. This is useful if RediSearch is only an index on an external document collection.

does not try to use stemming for query expansion but searches the query terms verbatim.

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

retrieves optional document payloads. See FT.CREATE. The payloads follow the document id and, if WITHSCORES is set, the scores.

returns the value of the sorting key, right after the id and score and/or payload, if requested. This is usually not needed, and exists for distributed search coordination purposes. This option is relevant only if used in conjunction with SORTBY.

limits results to those having numeric values ranging between min and max, if numeric_attribute is defined as a numeric attribute in FT.CREATE. min and max follow ZRANGE syntax, and can be -inf, +inf, and use ( for exclusive ranges. Multiple numeric filters for different attributes are supported in one query.

filter the results to a given radius from lon and lat. Radius is given as a number and units. See GEORADIUS for more details.

limits the result to a given set of keys specified in the list. The first argument must be the length of the list and greater than zero. Non-existent keys are ignored, unless all the keys are non-existent.

filters the results to those appearing only in specific attributes of the document, like title or URL. You must include num, which is the number of attributes you're filtering by. For example, if you request title and URL, then num is 2.

limits the attributes returned from the document. num is the number of attributes following the keyword. If num is 0, it acts like NOCONTENT. identifier is either an attribute name (for hashes and JSON) or a JSON Path expression (for JSON). property is an optional name used in the result. If not provided, the identifier is used in the result.

returns only the sections of the attribute that contain the matched text. See Highlighting for more information.

formats occurrences of matched text. See Highlighting for more information.

allows a maximum of N intervening number of unmatched offsets between phrase terms. In other words, the slop for exact phrases is 0.

puts the query terms in the same order in the document as in the query, regardless of the offsets between them. Typically used in conjunction with SLOP.

use a stemmer for the supplied language during search for query expansion. If querying documents in Chinese, set to chinese to properly tokenize the query terms. Defaults to English. If an unsupported language is sent, the command returns an error. See FT.CREATE for the list of languages.

uses a custom query expander instead of the stemmer. See Extensions.

uses a custom scoring function you define. See Extensions.

returns a textual description of how the scores were calculated. Using this options requires the WITHSCORES option.

adds an arbitrary, binary safe payload that is exposed to custom scoring functions. See Extensions.

orders the results by the value of this attribute. This applies to both text and numeric attributes. Attributes needed for SORTBY should be declared as SORTABLE in the index, in order to be available with very low latency. Note that this adds memory overhead.

limits the results to the offset and number of results given. Note that the offset is zero-indexed. The default is 0 10, which returns 10 items starting from the first result. You can use LIMIT 0 0 to count the number of documents in the result set without actually returning them.

overrides the timeout parameter of the module.

defines one or more value parameters. Each parameter has a name and a value.

You can reference parameters in the query by a $, followed by the parameter name, for example, $user. Each such reference in the search query to a parameter name is substituted by the corresponding parameter value. For example, with parameter definition PARAMS 4 lon 29.69465 lat 34.95126, the expression @loc:[$lon $lat 10 km] is evaluated to @loc:[29.69465 34.95126 10 km]. You cannot reference parameters in the query string where concrete values are not allowed, such as in field names, for example, @loc. To use PARAMS, set DIALECT to 2.

selects the dialect version under which to execute the query. If not specified, the query will execute under the default dialect version set during module initial loading or via FT.CONFIG SET command.

Search for the term "wizard" in every TEXT attribute of an index containing book data.

127.0.0.1:6379> FT.SEARCH books-idx "wizard"

Search for the term dogs in the title attribute.

127.0.0.1:6379> FT.SEARCH books-idx "@title:dogs"

Search for books published in 2020 or 2021.

127.0.0.1:6379> FT.SEARCH books-idx "@published_at:[2020 2021]"

Search for Chinese restaurants within 5 kilometers of longitude -122.41, latitude 37.77 (San Francisco).

127.0.0.1:6379> FT.SEARCH restaurants-idx "chinese @location:[-122.41 37.77 5 km]"

Search for the term dogs or cats in the title attribute, but give matches of dogs a higher relevance score (also known as boosting).

127.0.0.1:6379> FT.SEARCH books-idx "(@title:dogs | @title:cats) | (@title:dogs) => { $weight: 5.0; }"

Search for books with dogs in any TEXT attribute in the index and request an explanation of scoring for each result.

127.0.0.1:6379> FT.SEARCH books-idx "dogs" WITHSCORES EXPLAINSCORE

Searching for books with space in the title that have science in the TAG attribute categories:

127.0.0.1:6379> FT.SEARCH books-idx "@title:space @categories:{science}"

Searching for books with Python in any TEXT attribute, returning ten results starting with the eleventh result in the entire result set (the offset parameter is zero-based), and returning only the title attribute for each result:

127.0.0.1:6379> FT.SEARCH books-idx "python" LIMIT 10 10 RETURN 1 title

Search for books with Python in any TEXT attribute, returning the price stored in the original JSON document.

127.0.0.1:6379> FT.SEARCH books-idx "python" RETURN 3 $.book.price AS price

Search for books with semantically similar title to Planet Earth. Return top 10 results sorted by distance.

127.0.0.1:6379> FT.SEARCH books-idx "*=>[KNN 10 @title_embedding $query_vec AS title_score]" PARAMS 2 query_vec <"Planet Earth" embedding BLOB> SORTBY title_score DIALECT 2