Skip to content

Commit 690e7b4

Browse files
authored
Merge pull request #3352 from liyun95/v2.6.x
update docs
2 parents f9708da + 6fbb231 commit 690e7b4

File tree

3 files changed

+29
-13
lines changed

3 files changed

+29
-13
lines changed

assets/scann.png

31.3 KB
Loading

site/en/userGuide/indexes/floating-vector/scann.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,17 @@ The following table lists the parameters that can be configured in `params` when
107107
<th><p>Value Range</p></th>
108108
<th><p>Tuning Suggestion</p></th>
109109
</tr>
110+
<tr>
111+
<td><p><code>nlist</code></p></td>
112+
<td><p>Number of cluster units</p></td>
113+
<td><p>[1, 65536]</p></td>
114+
<td><p>A higher <em>nlist</em> increases pruning efficiency and typically speeds up coarse search, but partitions can get too small, which may reduce recall; a lower <em>nlist</em> scans larger clusters, improving recall but slowing search.</p></td>
115+
</tr>
110116
<tr>
111117
<td><p><code>with_raw_data</code></p></td>
112118
<td><p>Whether to store the original vector data alongside the quantized representation. When enabled, this allows for more accurate similarity calculations during the re-ranking phase by using the original vectors instead of quantized approximations.</p></td>
113-
<td><p><strong>Type</strong>: Boolean
114-
<strong>Range</strong>: <code>true</code>, <code>false</code></p>
115-
<p><strong>Default value</strong>: <code>true</code></p></td>
116-
<td><p>Set to <code>true</code> for <strong>higher search accuracy</strong> and when storage space is not a primary concern. The original vector data enables more precise similarity calculations during re-ranking.
117-
Set to <code>false</code> to <strong>reduce storage overhead</strong> and memory usage, especially for large datasets. However, this may result in slightly lower search accuracy as the re-ranking phase will use quantized vectors.</p>
118-
<p><strong>Recommended</strong>: Use <code>true</code> for production applications where accuracy is critical.</p></td>
119+
<td><p><strong>Type</strong>: Boolean</p><p><strong>Range</strong>: <code>true</code>, <code>false</code></p><p><strong>Default value</strong>: <code>true</code></p></td>
120+
<td><p>Set to <code>true</code> for <strong>higher search accuracy</strong> and when storage space is not a primary concern. The original vector data enables more precise similarity calculations during re-ranking.</p><p>Set to <code>false</code> to <strong>reduce storage overhead</strong> and memory usage, especially for large datasets. However, this may result in slightly lower search accuracy as the re-ranking phase will use quantized vectors.</p><p><strong>Recommended</strong>: Use <code>true</code> for production applications where accuracy is critical.</p></td>
119121
</tr>
120122
</table>
121123

@@ -133,13 +135,8 @@ The following table lists the parameters that can be configured in `search_param
133135
<tr>
134136
<td><p><code>reorder_k</code></p></td>
135137
<td><p>Controls the number of candidate vectors that are refined during the re-ranking phase. This parameter determines how many top candidates from the initial partitioning and quantization stages are re-evaluated using more precise similarity calculations.</p></td>
136-
<td><p><strong>Type</strong>: Integer
137-
<strong>Range</strong>: [1, <em>int_max</em>]</p>
138-
<p><strong>Default value</strong>: None</p></td>
139-
<td><p>A larger <code>reorder_k</code> generally leads to <strong>higher search accuracy</strong> as more candidates are considered during the final refinement phase. However, this also <strong>increases search time</strong> due to additional computation.
140-
Consider increasing <code>reorder_k</code> when achieving high recall is critical and search speed is less of a concern. A good starting point is 2-5x your desired <code>limit</code> (TopK results to return).</p>
141-
<p>Consider decreasing <code>reorder_k</code> to prioritize faster searches, especially in scenarios where a slight reduction in accuracy is acceptable.</p>
142-
<p>In most cases, we recommend you set a value within this range: [<em>limit</em>, <em>limit</em> * 5].</p></td>
138+
<td><p><strong>Type</strong>: Integer</p><p><strong>Range</strong>: [1, <em>int_max</em>]</p><p><strong>Default value</strong>: None</p></td>
139+
<td><p>A larger <code>reorder_k</code> generally leads to <strong>higher search accuracy</strong> as more candidates are considered during the final refinement phase. However, this also <strong>increases search time</strong> due to additional computation.</p><p>Consider increasing <code>reorder_k</code> when achieving high recall is critical and search speed is less of a concern. A good starting point is 2-5x your desired <code>limit</code> (TopK results to return).</p><p>Consider decreasing <code>reorder_k</code> to prioritize faster searches, especially in scenarios where a slight reduction in accuracy is acceptable.</p><p>In most cases, we recommend you set a value within this range: [<em>limit</em>, <em>limit</em> * 5].</p></td>
143140
</tr>
144141
</table>
145142

site/en/userGuide/search-query-get/boolean/geometry-operators.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
id: geometry-operators.md
33
title: "Geometry Operators"
44
summary: "Milvus supports a set of operators for spatial filtering on GEOMETRY fields, which are essential for managing and analyzing geometric data. These operators allow you to retrieve entities based on the geometric relationships between objects."
5+
beta: Milvus 2.6.4+
56
---
67

78
# Geometry Operators
@@ -12,6 +13,24 @@ All geometry operators function by taking two geometric arguments: the name of t
1213

1314
To learn more about `GEOMETRY` fields in Milvus, refer to [Geometry Field](geometry-field.md).
1415

16+
## Use syntax
17+
18+
To filter on a `GEOMETRY` field, use a geometry operator in an expression:
19+
20+
- General: `{operator}(geo_field, '{wkt}')`
21+
22+
- Distance-based: `ST_DWITHIN(geo_field, '{wkt}', distance)`
23+
24+
Where:
25+
26+
- `operator` is one of the supported geometry operators (e.g., `ST_CONTAINS`, `ST_INTERSECTS`). Operator names must be all uppercase or all lowercase. For a list of supported operators, refer to [Supported geometry operators](geometry-operators.md#Supported-geometry-operators).
27+
28+
- `geo_field` is the name of your `GEOMETRY` field.
29+
30+
- `'{wkt}'` is the WKT representation of the geometry to query.
31+
32+
- `distance` is the threshold specifically for `ST_DWITHIN`.
33+
1534
## Supported geometry operators
1635

1736
The following table lists the geometry operators available in Milvus.

0 commit comments

Comments
 (0)