英尺。搜索

语法

FT.SEARCH index query 
  [NOCONTENT] 
  [VERBATIM] 
  [NOSTOPWORDS] 
  [WITHSCORES] 
  [WITHPAYLOADS] 
  [WITHSORTKEYS] 
  [FILTER numeric_field min max [ FILTER numeric_field min max ...]] 
  [GEOFILTER geo_field lon lat radius m | km | mi | ft [ GEOFILTER geo_field lon lat radius m | km | mi | ft ...]] 
  [INKEYS count key [key ...]] 
  [INFIELDS count field [field ...]] 
  [RETURN count identifier [AS property] [ identifier [AS property] ...]] 
  [SUMMARIZE [ FIELDS count field [field ...]] [FRAGS num] [LEN fragsize] [SEPARATOR separator]] 
  [HIGHLIGHT [ FIELDS count field [field ...]] [ TAGS open close]] 
  [SLOP slop] 
  [TIMEOUT timeout] 
  [INORDER] 
  [LANGUAGE language] 
  [EXPANDER expander] 
  [SCORER scorer] 
  [EXPLAINSCORE] 
  [PAYLOAD payload] 
  [SORTBY sortby [ ASC | DESC] [WITHCOUNT]] 
  [LIMIT offset num] 
  [PARAMS nargs name value [ name value ...]] 
  [DIALECT dialect]

可用：: Redis 堆栈 / 搜索 1.0.0
时间复杂度：: O（N）

使用文本查询搜索索引，返回 documents 或仅返回 id

例子

必需参数

index

是索引名称。您必须首先使用FT.CREATE.

query

是要搜索的文本查询。如果它不止一个单词，请将其放在引号中。请参阅查询语法以了解更多详细信息。

可选参数

NOCONTENT

返回文档 ID，而不是内容。如果 RediSearch 只是外部文档集合上的索引，则这非常有用。

VERBATIM

不尝试使用词干提取进行查询扩展，而是逐字搜索查询词。

NOSTOPWORDS

忽略全文搜索中任何定义的停用词。

WITHSCORES

还返回每个文档的相对内部分数。这可用于合并来自多个实例的结果。

WITHPAYLOADS

检索可选的文档负载。看FT.CREATE.有效负载遵循文档 ID，如果WITHSCORES设定了，分数。

WITHSORTKEYS

返回排序键的值，紧跟在 ID 和 score 和/或 payload 之后（如果请求）。这通常不是必需的，并且存在用于分布式搜索协调目的。此选项仅在与SORTBY.

FILTER numeric_attribute min max

将结果限制为数值介于min和max，如果 numeric_attribute 被定义为FT.CREATE.min和max跟随ZRANGE语法，并且可以是-inf,+inf，并用于独占范围。一个查询支持不同属性的多个数值筛选条件。v2.10 后已移除：查询方言 2 解释了替换此参数的数字字段的查询语法。(

GEOFILTER {geo_attribute} {lon} {lat} {radius} m|km|mi|ft

将结果筛选为给定的radius从lon和lat.半径以数字和单位的形式给出。看GEORADIUS了解更多详情。从 v2.6 开始不推荐使用：查询方言 3 解释了替换此参数的地理空间字段的查询语法。

INKEYS {num} {attribute} ...

将结果限制为列表中指定的一组给定键。第一个参数必须是列表的长度且大于零。不存在的键将被忽略，除非所有键都不存在。

INFIELDS {num} {attribute} ...

将结果筛选为仅显示在文档的特定属性中的结果，例如title或URL.您必须包括num，这是您筛选所依据的属性数。例如，如果您请求title和URL然后num是 2。

RETURN {num} {identifier} AS {property} ...

限制从文档返回的属性。num是关键字后面的属性数。如果num为 0，则其作用类似于NOCONTENT.identifier是属性名称（对于哈希和 JSON）或 JSON 路径表达式（对于 JSON）。property是结果中使用的可选名称。如果未提供，则identifier在结果中使用。

SUMMARIZE ...

仅返回包含匹配文本的属性部分。有关更多信息，请参阅突出显示。

HIGHLIGHT ...

设置匹配项的文本的格式。有关更多信息，请参阅突出显示。

SLOP {slop}

是允许在查询词之间出现的中间词数。假设您正在搜索短语 hello world。如果某些术语出现在 hello 和 world 之间，则SLOP大于0允许这些文本属性匹配。默认情况下，没有SLOP约束。

INORDER

要求文档中的术语与查询中的术语具有相同的顺序，而不管它们之间的偏移量如何。通常与SLOP.默认值为false.

LANGUAGE {language}

在搜索查询扩展期间，对提供的语言使用词干分析器。如果查询中文文档，请设置为chinese自正确标记查询词。默认为 English。如果发送了不受支持的语言，该命令将返回错误。看FT.CREATE以获取语言列表。如果LANGUAGE指定为索引的一部分创建，则不需要使用FT.SEARCH.

EXPANDER {expander}

使用自定义查询扩展器而不是词干分析器。请参阅扩展。

SCORER {scorer}

使用内置或用户提供的评分函数。

EXPLAINSCORE

返回分数计算方式的文本描述。使用此选项需要WITHSCORES.

PAYLOAD {payload}

添加向自定义评分函数公开的任意二进制安全有效负载。请参阅扩展。

SORTBY {attribute} [ASC|DESC] [WITHCOUNT]

按此属性的值对结果进行排序。这适用于 text 和 numeric 属性。所需的属性SORTBY应声明为SORTABLE，以便以非常低的延迟可用。请注意，这会增加内存开销。

排序优化：针对以下排序作优化性能DIALECT 4在不同场景下：

Skip Sorter - 在没有任何类型的情况下应用。查询可以在到达LIMIT请求的结果。
部分范围 - 当存在SORTBY子句，如果没有 filter 或按同一 numeric 字段进行筛选，则查询将迭代足够大的范围以满足LIMIT请求的结果。
Hybrid - 在存在SORTBY子句和另一个非数字筛选器。某些结果将被筛选，并且初始范围可能不够大。然后，迭代器使用以下范围倒带，并进行额外的迭代以收集LIMIT请求的结果。
无优化 - 如果存在按分数或按非数字字段排序，则除了检索所有结果并比较其值外，别无选择。

计数行为：可选WITHCOUNTargument 返回查询结果的准确计数和排序。此作处理所有结果以获得准确的计数，其性能低于 optimized 选项（默认行为为DIALECT 4)

LIMIT first num

将结果限制为给定的偏移量和结果数。请注意，偏移量是零索引的。默认值为 0 10，从第一个结果开始返回 10 个项目。您可以使用LIMIT 0 0来计算结果集中的文档数，而不实际返回它们。

LIMIT行为：如果使用LIMIT选项，则返回的结果是不确定的，这意味着后续查询可能会返回重复或缺失的值。加SORTBY替换为唯一字段，或使用FT.AGGREGATE使用WITHCURSOR选项来确保确定性的结果集分页。

TIMEOUT {milliseconds}

覆盖模块的 timeout 参数。

PARAMS {nargs} {name} {value}

定义一个或多个值参数。每个参数都有一个名称和一个值。

您可以在query通过 a ，后跟参数名称，例如$$user.搜索查询中对参数名称的每个此类引用都由相应的参数值替换。例如，使用参数定义PARAMS 4 lon 29.69465 lat 34.95126、表达式@loc:[$lon $lat 10 km]的计算结果为@loc:[29.69465 34.95126 10 km].您不能在不允许使用具体值的查询字符串中引用参数，例如在字段名称中，例如@loc.要使用PARAMS设置DIALECT自2或大于2（这需要 RediSearch v2.4 或更高版本）。

DIALECT {dialect_version}

选择要在其下执行查询的 dialect 版本。如果未指定，查询将在模块初始加载期间设置的默认方言版本下执行，或通过FT.CONFIG SET命令。有关更多信息，请参阅查询方言。

英尺。SEARCH 返回数组回复，其中第一个元素是结果总数的整数回复，然后是文档 ID 的数组回复对和属性/值对的数组回复。

笔记：

如果NOCONTENT，则返回一个数组，其中第一个元素是结果的总数，其余成员是文档 ID。
如果相关键在查询运行时过期，则尝试加载键的值将返回 null 数组。但是，键仍计入结果总数。

返回多个值

定义索引时ON JSON时，当 JSONPath 匹配多个值或 JSONPath 匹配数组时，单个属性或单个 JSONPath 的回复可能会返回多个值。

在 RediSearch v2.6 之前，仅返回第一个匹配值。从 RediSearch v2.6 开始，将返回所有值，并用顶级数组包装。

为了保持向后兼容性，RediSearch v2.6 的默认行为是仅返回第一个值。

要返回所有值，请使用DIALECT3（或更大，如果可用）。

这DIALECT可以作为 FT 中的参数指定。SEARCH 命令。如果未指定，则DEFAULT_DIALECT，可以使用FT.CONFIG SET或者将其作为参数传递给redisearch模块。

例如，使用以下 document 和 index：

127.0.0.1:6379> JSON.SET doc:1 $ '[{"arr": [1, 2, 3]}, {"val": "hello"}, {"val": "world"}]'
OK
127.0.0.1:6379> FT.CREATE idx ON JSON PREFIX 1 doc: SCHEMA $..arr AS arr NUMERIC $..val AS val TEXT
OK

Notice the different replies, with and without DIALECT 3:


127.0.0.1:6379> FT.SEARCH idx * RETURN 2 arr val
1) (integer) 1
2) "doc:1"
3) 1) "arr"
   2) "[1,2,3]"
   3) "val"
   4) "hello"

127.0.0.1:6379> FT.SEARCH idx * RETURN 2 arr val DIALECT 3
1) (integer) 1
2) "doc:1"
3) 1) "arr"
   2) "[[1,2,3]]"
   3) "val"
   4) "[\"hello\",\"world\"]"
Complexity

FT.SEARCH complexity is O(n) for single word queries. n is the number of the results in the result set. Finding all the documents that have a specific term is O(1), however, a scan on all those documents is needed to load the documents data from redis hashes and return them.
The time complexity for more complex queries varies, but in general it's proportional to the number of words, the number of intersection points between them and the number of results in the result set.
Examples

Search for a term in every text attribute
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 a term in title attribute
Search for the term dogs in the title attribute.
127.0.0.1:6379> FT.SEARCH books-idx "@title:dogs"



Search for books from specific years
Search for books published in 2020 or 2021.
127.0.0.1:6379> FT.SEARCH books-idx "@published_at:[2020 2021]"



Search for a restaurant by distance from longitude/latitude
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 a book by terms but boost specific term
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 a book by a term and EXPLAINSCORE
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



Search for a book by a term and TAG
Search 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}"



Search for a book by a term but limit the number
Search for books with Python in any TEXT attribute, returning 10 results starting with the 11th result in the entire result set (the offset parameter is zero-based), and return 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 a book by a term and price
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 a book by title and distance
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



Search for a phrase using SLOP
Search for a phrase hello world.
First, create an index.
127.0.0.1:6379> FT.CREATE memes SCHEMA phrase TEXT
OK

Add variations of the phrase hello world.
127.0.0.1:6379> HSET s1 phrase "hello world"
(integer) 1
127.0.0.1:6379> HSET s2 phrase "hello simple world"
(integer) 1
127.0.0.1:6379> HSET s3 phrase "hello somewhat less simple world"
(integer) 1
127.0.0.1:6379> HSET s4 phrase "hello complicated yet encouraging problem solving world"
(integer) 1
127.0.0.1:6379> HSET s5 phrase "hello complicated yet amazingly encouraging problem solving world"
(integer) 1

Then, search for the phrase hello world. The result returns all documents that contain the phrase.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(hello world)' NOCONTENT 
1) (integer) 5
2) "s1"
3) "s2"
4) "s3"
5) "s4"
6) "s5"

Now, return all documents that have one of fewer words between hello and world.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(hello world)' NOCONTENT SLOP 1
1) (integer) 2
2) "s1"
3) "s2"

Now, return all documents with three or fewer words between hello and world.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(hello world)' NOCONTENT SLOP 3
1) (integer) 3
2) "s1"
3) "s2"
4) "s3"

s5 needs a higher SLOP to match, SLOP 6 or higher, to be exact. See what happens when you set SLOP to 5.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(hello world)' NOCONTENT SLOP 5
1) (integer) 4
2) "s1"
3) "s2"
4) "s3"
5) "s4"

If you add additional terms (and stemming), you get these results.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(hello amazing world)' NOCONTENT 
1) (integer) 1
2) "s5"

127.0.0.1:6379> FT.SEARCH memes '@phrase:(hello encouraged world)' NOCONTENT SLOP 5
1) (integer) 2
2) "s4"
3) "s5"

127.0.0.1:6379> FT.SEARCH memes '@phrase:(hello encouraged world)' NOCONTENT SLOP 4
1) (integer) 1
2) "s4"

If you swap the terms, you can still retrieve the correct phrase.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(amazing hello world)' NOCONTENT
1) (integer) 1
2) "s5"

But, if you use INORDER, you get zero results.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(amazing hello world)' NOCONTENT INORDER
1) (integer) 0

Likewise, if you use a query attribute $inorder set to true, s5 is not retrieved.
127.0.0.1:6379> FT.SEARCH memes '@phrase:(amazing hello world)=>{$inorder: true;}' NOCONTENT
1) (integer) 0

To sum up, the INORDER argument or $inorder query attribute require the query terms to match terms with similar ordering.


Polygon Search with WITHIN, CONTAINS, INTERSECTS, and DISJOINT operators
Query for polygons which:

contain a given geoshape
are within a given geoshape
intersect with a given geoshape
are disjoint (nothing in common) with a given shape

INTERSECTS and DISJOINT were introduced in v2.10.
First, create an index using GEOSHAPE type with a FLAT coordinate system:
127.0.0.1:6379> FT.CREATE idx SCHEMA geom GEOSHAPE FLAT
OK

Adding a couple of geometries using HSET:
127.0.0.1:6379> HSET small geom 'POLYGON((1 1, 1 100, 100 100, 100 1, 1 1))'
(integer) 1
127.0.0.1:6379> HSET large geom 'POLYGON((1 1, 1 200, 200 200, 200 1, 1 1))'
(integer) 1

Query with WITHIN operator:
127.0.0.1:6379> FT.SEARCH idx '@geom:[WITHIN $poly]' PARAMS 2 poly 'POLYGON((0 0, 0 150, 150 150, 150 0, 0 0))' DIALECT 3

1) (integer) 1
2) "small"
3) 1) "geom"
   2) "POLYGON((1 1, 1 100, 100 100, 100 1, 1 1))"

Query with CONTAINS operator:
127.0.0.1:6379> FT.SEARCH idx '@geom:[CONTAINS $poly]' PARAMS 2 poly 'POLYGON((2 2, 2 50, 50 50, 50 2, 2 2))' DIALECT 3

1) (integer) 2
2) "small"
3) 1) "geom"
   2) "POLYGON((1 1, 1 100, 100 100, 100 1, 1 1))"
4) "large"
5) 1) "geom"
   2) "POLYGON((1 1, 1 200, 200 200, 200 1, 1 1))"


See also
FT.CREATE | FT.AGGREGATE
Related topics

Extensions
Highlighting
Query syntax
RediSearch



        
        
        
        


        
          History
          
            
            Starting with Redis version 2.0.0: Deprecated WITHPAYLOADS and PAYLOAD arguments
            
            Starting with Redis version 2.6: Deprecated GEOFILTER argument
            
            Starting with Redis version 2.10: Deprecated FILTER argument
            
          
        

        

  
  
    
      RATE THIS PAGE
      
        
        
        ★
        
        
        ★
        
        
        ★
        
        
        ★
        
        
        ★
        
      
      
    
      Back to top ↑



    
      
      
      
      
      
        
















        
          See also
        
        
          
            FT._LIST
          
        
          
            FT.AGGREGATE
          
        
          
            FT.ALIASADD
          
        
          
            FT.ALIASDEL
          
        
          
            FT.ALIASUPDATE
          
        
          
            FT.ALTER
          
        
          
            FT.CONFIG GET
          
        
          
            FT.CONFIG SET
          
        
          
            FT.CREATE
          
        
          
            FT.CURSOR DEL
          
        
          
            FT.CURSOR READ
          
        
          
            FT.DICTADD
          
        
          
            FT.DICTDEL
          
        
          
            FT.DICTDUMP
          
        
          
            FT.DROPINDEX
          
        
          
            FT.EXPLAIN
          
        
          
            FT.EXPLAINCLI
          
        
          
            FT.INFO
          
        
          
            FT.PROFILE
          
        
          
            FT.SEARCH
          
        
          
            FT.SPELLCHECK
          
        
          
            FT.SYNDUMP
          
        
          
            FT.SYNUPDATE
          
        
          
            FT.TAGVALS