英尺。轮廓

语法

FT.PROFILE index SEARCH | AGGREGATE [LIMITED] QUERY query

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

应用FT.SEARCH或FT.AGGREGATE命令来收集性能详细信息。有关用法，请参阅示例。

必需参数

index

是使用FT.CREATE.

SEARCH | AGGREGATE

表示配置文件类型，则FT.SEARCH或FT.AGGREGATE.

LIMITED

删除任何reader迭代器。

QUERY {query}

是查询字符串，发送到FT.SEARCH或FT.AGGREGATE.

注意：要减小输出的大小，请使用NOCONTENT或LIMIT 0 0以减少回复结果的数量，或者LIMITED不回复reader iterators在内置联合中，例如fuzzy或prefix迭代器。

FT.PROFILE返回一个双元素数组 reply。第一个元素包含提供的FT.SEARCH或FT.AGGREGATE命令。第二个元素包含有关查询创建、迭代器配置文件和结果处理器配置文件的信息。第二个元素的详细信息如下。

结果

此部分包含搜索结果。

每个分片配置文件

本部分包含每个分片的查询执行详细信息。当有多个分片在游戏中时，分片将被标记Shard #1,Shard #2等。如果只有一个分片，则将省略标签。

返回的字段名称	定义
`Total` `profile` `time`	查询的总运行时间（ms）。通常只有几毫秒。
`Parsing` `time`	将查询及其参数解析为查询计划所花费的时间（ms）。通常只有几毫秒。
`Pipeline` `creation` `time`	执行计划的创建时间（ms），包括迭代器、结果处理器和 reducer 的创建时间。通常只需几毫秒`FT.SEARCH`queries 的 URL 中，但`FT.AGGREGATE`查询。
`Warning`	查询执行期间发生的错误。

Iterator 配置文件

本节包含索引迭代器信息，包括Type,Query Type,Term（如适用）、Time（以毫秒为单位）、Counter,Child iterator和Size信息。每个迭代器表示查询计划的每个部分的执行程序，按执行计划嵌套。下面提到的作类型（UNION等）应与提供的查询匹配。

倒排索引迭代器还包括它们包含的元素数。混合向量迭代器批量返回向量索引中的排名靠前的结果，包括批次数。

迭代器类型包括：

INTERSECT（和）与Child iterator
UNION（或）Child iterator
NOT (-）替换为Child iterator
Child iterator- 复合查询的子查询组件的详细信息。
TEXT跟Term
TAG跟Term
NUMERIC跟Term
VECTOR
EMPTY
WILDCARD
OPTIONAL

注意事项Counter和Size

Counter 是与迭代器交互的次数。与其他值相比，非常高的值可能是警告标志。NUMERIC和Child interator类型被划分为 ranges，并且Counter将根据范围而变化。为UNION，子迭代器中的计数器之和应等于或大于子迭代器的计数器。

Size是文档集的大小。Counter应始终等于或小于Size.

结果处理器配置文件

结果处理器在 Redis 查询引擎中形成强大的管道。它们分阶段工作，以根据复杂的查询需求尽可能高效地收集、筛选、评分、排序和返回结果。每个处理器报告Time信息，表示处理器完成其作所花费的总持续时间（以毫秒或 ms 为单位），以及Counter信息，指示在查询期间调用处理器的次数。

类型	定义
`Metrics` `Applier`	这`Metrics Applier`处理器计算或聚合与搜索结果相关的特定量度。例如，这可能包括将距离或相似性指标应用于矢量搜索结果，或者根据相关性或其他参数计算分数。
`Index`	这`Index`processor 负责根据初始查询条件（例如，全文术语、过滤器或数字范围）从索引中检索匹配文档的核心检索。
`Scorer`	这`Scorer`Processor 根据查询的指定评分函数为每个文档分配相关性分数。此函数可能涉及术语频率、反向文档频率或其他加权指标等因素。
`Sorter`	这`Sorter`processor 根据指定的排序标准排列查询结果。这可以是字段值（例如，按价格、日期或其他属性排序）或按评分阶段分配的分数。它在获取文档并对其进行评分后运行，确保结果按照查询的要求进行排序（例如，升序或降序）。`Scorer`结果将始终出现在`FT.SEARCH`配置文件。
`Loader`	这`Loader`Processor 在对结果进行排序和筛选后检索文档内容。它确保仅加载查询指定的字段，从而提高效率，尤其是在处理只需要几个字段的大型文档时。
`Highlighter`	这`Highlighter`processor 用于突出显示搜索结果中的匹配词。这对于全文搜索应用程序特别有用，因为 UI 中经常强调相关术语。
`Paginator`	这`Paginator`processor 负责通过将结果限制在特定范围内（例如，LIMIT 0 10）来处理分页。它缩减结果集以适应所需的分页窗口，确保在处理大型结果集时有效地使用内存。
`Vector` `Filter`	对于向量搜索，`Vector Filter`处理器有时用于在主要评分和排序之前根据向量相似性阈值对结果进行预处理。

协调者

此部分仅在多分片环境中运行时显示。

返回的字段名称	定义
`Total coordinator time`	从查询执行开始到所有分片完成查询执行的时间。（毫秒）
`Post-processing time`	生成 FT.PROFILE 输出（开销）（毫秒）。

例子

收集有关简单 JSON 索引的性能信息。

假设您有（1）一个由 10 个 JSON 文档组成的数据集，每个文档具有以下结构;

{
  "pickup_zone": "POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))",
  "store_location": "-74.0060,40.7128",
  "brand": "Velorim",
  "model": "Jigger",
  "price": 270,
  "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
  "condition": "new"
}

And (2) a corresponding index:


FT.CREATE idx:bicycle ON JSON PREFIX 1 bicycle: SCORE 1.0 SCHEMA $.pickup_zone AS pickup_zone GEOSHAPE $.store_location AS store_location GEO $.brand AS brand TEXT WEIGHT 1.0 $.model AS model TEXT WEIGHT 1.0 $.description AS description TEXT WEIGHT 1.0 $.price AS price NUMERIC $.condition AS condition TAG SEPARATOR ,
Here's an example of running the FT.PROFILE command for a compound query.

127.0.0.1:6379> ft.profile idx:bicycle search query "@description:(kids | small) @condition:{new | used}"
1) 1) (integer) 3
   2) "bicycle:0"
   3) 1) "$"
      2) "{\"pickup_zone\":\"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))\",\"store_location\":\"-74.0060,40.7128\",\"brand\":\"Velorim\",\"model\":\"Jigger\",\"price\":270,\"description\":\"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids\xe2\x80\x99 pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.\",\"condition\":\"new\"}"
   4) "bicycle:1"
   5) 1) "$"
      2) "{\"pickup_zone\":\"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, -118.2887 33.9872, -118.2887 34.0972))\",\"store_location\":\"-118.2437,34.0522\",\"brand\":\"Bicyk\",\"model\":\"Hillcraft\",\"price\":1200,\"description\":\"Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\\\" wheel bike is just too clumsy coming off a 24\\\" bike. The Hillcraft 26 is just the solution they need!\",\"condition\":\"used\"}"
   6) "bicycle:2"
   7) 1) "$"
      2) "{\"pickup_zone\":\"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, -87.6848 41.8231, -87.6848 41.9331))\",\"store_location\":\"-87.6298,41.8781\",\"brand\":\"Nord\",\"model\":\"Chook air 5\",\"price\":815,\"description\":\"The Chook Air 5  gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower  top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.\",\"condition\":\"used\"}"
2) 1) 1) Total profile time
      2) "0"
   2) 1) Parsing time
      2) "0"
   3) 1) Pipeline creation time
      2) "0"
   4) 1) Warning
   5) 1) Iterators profile
      2) 1) Type
         2) INTERSECT
         3) Time
         4) "0"
         5) Counter
         6) (integer) 6
         7) Child iterators
         8)  1) Type
             2) UNION
             3) Query type
             4) UNION
             5) Time
             6) "0"
             7) Counter
             8) (integer) 6
             9) Child iterators
            10)  1) Type
                 2) UNION
                 3) Query type
                 4) UNION
                 5) Time
                 6) "0"
                 7) Counter
                 8) (integer) 4
                 9) Child iterators
                10)  1) Type
                     2) TEXT
                     3) Term
                     4) kids
                     5) Time
                     6) "0"
                     7) Counter
                     8) (integer) 4
                     9) Size
                    10) (integer) 4
                11)  1) Type
                     2) TEXT
                     3) Term
                     4) +kid
                     5) Time
                     6) "0"
                     7) Counter
                     8) (integer) 4
                     9) Size
                    10) (integer) 4
            11)  1) Type
                 2) TEXT
                 3) Term
                 4) small
                 5) Time
                 6) "0"
                 7) Counter
                 8) (integer) 2
                 9) Size
                10) (integer) 2
         9)  1) Type
             2) UNION
             3) Query type
             4) TAG
             5) Time
             6) "0"
             7) Counter
             8) (integer) 6
             9) Child iterators
            10)  1) Type
                 2) TAG
                 3) Term
                 4) new
                 5) Time
                 6) "0"
                 7) Counter
                 8) (integer) 4
                 9) Size
                10) (integer) 10
            11)  1) Type
                 2) TAG
                 3) Term
                 4) used
                 5) Time
                 6) "0"
                 7) Counter
                 8) (integer) 4
                 9) Size
                10) (integer) 8
   6) 1) Result processors profile
      2) 1) Type
         2) Index
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3
      3) 1) Type
         2) Scorer
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3
      4) 1) Type
         2) Sorter
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3
      5) 1) Type
         2) Loader
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3



Collect performance information about a JSON index that includes vector data.
For this example, you'll create a very simple vector database and index.
Index:
FT.CREATE vss_idx ON JSON PREFIX 1 vec: SCHEMA $.vector AS vector VECTOR FLAT 6 TYPE FLOAT32 DIM 4 DISTANCE_METRIC L2
Database:
JSON.SET vec:1 $ '{"vector":[1,1,1,1]}'
JSON.SET vec:2 $ '{"vector":[2,2,2,2]}'
JSON.SET vec:3 $ '{"vector":[3,3,3,3]}'
JSON.SET vec:4 $ '{"vector":[4,4,4,4]}'
Here's an example of running the FT.PROFILE command for a vector query.
127.0.0.1:6379> ft.profile vss_idx search query "*=>[KNN 3 @vector $query_vec]" PARAMS 2 query_vec "\x00\x00\x00@\x00\x00\x00@\x00\x00@@\x00\x00@@" SORTBY __vector_score DIALECT 2
1) 1) (integer) 3
   2) "vec:2"
   3) 1) "__vector_score"
      2) "2"
      3) "$"
      4) "{\"vector\":[2,2,2,2]}"
   4) "vec:3"
   5) 1) "__vector_score"
      2) "2"
      3) "$"
      4) "{\"vector\":[3,3,3,3]}"
   6) "vec:1"
   7) 1) "__vector_score"
      2) "10"
      3) "$"
      4) "{\"vector\":[1,1,1,1]}"
2) 1) 1) Total profile time
      2) "0"
   2) 1) Parsing time
      2) "0"
   3) 1) Pipeline creation time
      2) "0"
   4) 1) Warning
   5) 1) Iterators profile
      2) 1) Type
         2) VECTOR
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3
   6) 1) Result processors profile
      2) 1) Type
         2) Index
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3
      3) 1) Type
         2) Metrics Applier
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3
      4) 1) Type
         2) Sorter
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3
      5) 1) Type
         2) Loader
         3) Time
         4) "0"
         5) Counter
         6) (integer) 3


See also
FT.SEARCH | FT.AGGREGATE
Related topics
RediSearch


        
        
        
        


        

        

  
  
    
      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