Skip to content

Commit f886a42

Browse files
committed
DWD copy-edit pass
1 parent d36ef27 commit f886a42

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

content/commands/ft.profile.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,10 @@ is the query string, sent to `FT.SEARCH` or `FT.AGGREGATE`.
8787

8888
## Return
8989

90-
**Note**: This page contains the up-to-date profile output as of RediSearch v2.8.33, v2.10.26, v8.2.7, and v8.4.3.
90+
{{< note>}}
91+
This page contains the up-to-date profile output as of RediSearch v2.8.33, v2.10.26, v8.2.7, and v8.4.3.
9192
The output format itself may differ between RediSearch versions, and RESP protocol versions.
93+
{{< /note >}}
9294

9395
`FT.PROFILE` returns a two-element array reply. The first element contains the results of the provided `FT.SEARCH` or `FT.AGGREGATE` command.
9496
The second element contains information about query creation, iterator profiles, and result processor profiles.
@@ -102,7 +104,7 @@ If there's only one shard, the label will be omitted.
102104

103105
| Returned field name | Definition |
104106
|:-- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
105-
| `Shard ID` | String containing the unique shard ID. In OSS, this identifier is denoted as the node ID, and is recievend from `RedisModule_GetMyClusterID()` API. (Available as of RediSearch v8.4.3) |
107+
| `Shard ID` | String containing the unique shard ID. In Redis Open Source, this identifier is denoted as the node ID, and is received from the `RedisModule_GetMyClusterID()` API. (Available as of RediSearch v8.4.3) |
106108
| `Total`&nbsp;`profile`&nbsp;`time` | The total run time (ms) of the query. Normally just a few ms. |
107109
| `Parsing`&nbsp;`time` | The time (ms) spent parsing the query and its parameters into a query plan. Normally just a few ms. |
108110
| `Pipeline`&nbsp;`creation`&nbsp;`time` | The creation time (ms) of the execution plan, including iterators, result processors, and reducers creation. Normally just a few ms for `FT.SEARCH` queries, but expect a larger number for `FT.AGGREGATE` queries. |
@@ -112,10 +114,10 @@ If there's only one shard, the label will be omitted.
112114

113115
### Iterator profiles
114116

115-
This section contains index iterator information, including `Type`, `Query Type`, `Term` (when applicable), `Time` (in ms), `Number of reading operations`, `Child iterator`, and `Estimated number of matches` information.
116-
Each iterator represents an executor for each part of the query plan, nested per the execution plan. The operation types mentioned below (`UNION`, etc) should match up with the provided query.
117+
This section contains index iterator information, including `Type`, `Query Type`, `Term` (when applicable), `Time` (ms), `Number of reading operations`, `Child iterator`, and `Estimated number of matches` information.
118+
Each iterator represents an executor for each part of the query plan, nested per the execution plan. The operation types mentioned below (for example, `UNION`) should match up with the provided query.
117119

118-
Inverted-index iterators also include the number of elements they contain. Vector iterators include additional profiling information. See [Vector iterator profile](#vector-iterator-profile) below.
120+
Inverted-index iterators also include the number of elements they contain. Vector iterators include additional profiling information. See [Notes on Vector iterator profile](#notes-onvector-iterator-profile) below.
119121

120122
Iterator types include:
121123

@@ -132,16 +134,16 @@ Iterator types include:
132134
* `EMPTY`
133135
* `WILDCARD`
134136
* `OPTIONAL`
135-
* `OPTIMIZER` with `Optimizer mode` - Query optimization wrapper for `FT.SEARCH` queries sorted by a numeric field. Enabled by default in dialect 4+, or explicitly with `WITHOUTCOUNT`.
137+
* `OPTIMIZER` with `Optimizer mode` - Query optimization wrapper for `FT.SEARCH` queries sorted by a numeric field. Enabled by default in [DIALECT 4]({{< relref "/develop/ai/search-and-query/advanced-concepts/dialects##dialect-4-deprecated" >}}) or explicitly with `WITHOUTCOUNT`.
136138
* `ID-LIST` - Iterator over specific document IDs (appears when using `INKEYS`)
137139

138140
**Notes on `Number of reading operations` and `Estimated number of matches`**
139141

140-
`Number of reading operations` is the number of times an iterator was interacted with. A very high value in comparison to others is a possible warning flag. `NUMERIC` and `Child iterator` types are broken into ranges, and `Number of reading operations` will vary depending on the range. For `UNION`, the sum of the reading operations in child iterators should be equal or greater than the child iterator's reading operations.
142+
`Number of reading operations` is the number of times an iterator was interacted with. A very high value in comparison to others is a possible warning flag. `NUMERIC` and `Child iterator` types are broken into ranges, and `Number of reading operations` will vary depending on the range. For `UNION`, the sum of the reading operations in child iterators should be equal to or greater than the child iterator's reading operations.
141143

142-
`Estimated number of matches` is the size of the document set. `Number of reading operations` should always be equal or less than `Estimated number of matches`.
144+
`Estimated number of matches` is the size of the document set. `Number of reading operations` should always be equal to or less than `Estimated number of matches`.
143145

144-
**Notes on Vector iterator profile**
146+
#### Notes on Vector iterator profile {#notes-onvector-iterator-profile}
145147

146148
For vector queries, the iterator profile includes additional information specific to vector search execution.
147149

@@ -152,7 +154,7 @@ The `Vector search mode` field indicates the execution strategy used for both `V
152154
| Mode | Description |
153155
|:-- |:-- |
154156
| `STANDARD_KNN` | Pure KNN vector search without filters. |
155-
| `RANGE_QUERY` | Range-based vector search. used with `VECTOR_RANGE` queries. |
157+
| `RANGE_QUERY` | Range-based vector search. Used with `VECTOR_RANGE` queries. |
156158
| `HYBRID_ADHOC_BF` | Ad-hoc brute force for filtered queries. Iterates through results that pass the filter and calculates distances on-the-fly. |
157159
| `HYBRID_BATCHES` | Batch-based filtered search. Retrieves top vectors from the index in batches and checks which ones pass the filter. |
158160
| `HYBRID_BATCHES_TO_ADHOC_BF`| Dynamic mode switching. Starts with batch-based search but switches to ad-hoc brute force if batch iterations yield insufficient results. |

0 commit comments

Comments
 (0)