Skip to content

Commit 6ea6c59

Browse files
committed
consistent docs with fix to reference the range starting at 0
1 parent ae3e566 commit 6ea6c59

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/reference/elasticsearch/mapping-reference/dense-vector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ $$$dense-vector-index-options$$$
365365
: (Optional, float) Only applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types. The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and `1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for optimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating the quantization thresholds. For example, a value of `0.95` will only use the middle 95% of the values when calculating the quantization thresholds (e.g. the highest and lowest 2.5% of values will be ignored). Defaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation.
366366

367367
`default_visit_percentage` {applies_to}`stack: ga 9.2`
368-
: (Optional, integer) Only applicable to `bbq_disk`. The default percentage of vectors to visit when exploring each shard. Defaults to ~1% for every 1 million vectors.
368+
: (Optional, integer) Only applicable to `bbq_disk`. Must be between 0 and 100. 0 will default to using `num_candidates` for calculating the percent visited. Increasing `default_visit_percentage` tends to improve the accuracy of the final results. Defaults to ~1% per shard for every 1 million vectors.
369369

370370
`cluster_size` {applies_to}`stack: ga 9.2`
371371
: (Optional, integer) Only applicable to `bbq_disk`. The number of vectors per cluster. Smaller cluster sizes increases accuracy at the cost of performance. Defaults to `384`. Must be a value between `64` and `65536`.

docs/reference/elasticsearch/rest-apis/retrievers/knn-retriever.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ stack: ga 9.2
4747
`visit_percentage`
4848
: (Optional, float)
4949

50-
The percentage of vectors to explore per shard while doing knn search with `bbq_disk`. Must be between 1 and 100. 0 will default to using `num_candidates` for calculating the percent visited. Increasing `visit_percentage` tends to improve the accuracy of the final results. If `visit_percentage` is set for `bbq_disk`, `num_candidates` is ignored. Defaults to a reasonable percent per shard of ~1% for every 1 million vectors.
50+
The percentage of vectors to explore per shard while doing knn search with `bbq_disk`. Must be between 0 and 100. 0 will default to using `num_candidates` for calculating the percent visited. Increasing `visit_percentage` tends to improve the accuracy of the final results. If `visit_percentage` is set for `bbq_disk`, `num_candidates` is ignored. Defaults to ~1% per shard for every 1 million vectors.
5151

5252

5353
`filter`

docs/reference/query-languages/query-dsl/query-dsl-knn-query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ If all queried fields are of type [semantic_text](/reference/elasticsearch/mappi
9494
stack: ga 9.2
9595
```
9696
`visit_percentage`
97-
: (Optional, float) The percentage of vectors to explore per shard while doing knn search with `bbq_disk`. Must be between 1 and 100. 0 will default to using `num_candidates` for calculating the percent visited. Increasing `visit_percentage` tends to improve the accuracy of the final results. If `visit_percentage` is set for `bbq_disk`, `num_candidates` is ignored. Defaults to 1% per shard for every 1 million vectors.
97+
: (Optional, float) The percentage of vectors to explore per shard while doing knn search with `bbq_disk`. Must be between 0 and 100. 0 will default to using `num_candidates` for calculating the percent visited. Increasing `visit_percentage` tends to improve the accuracy of the final results. If `visit_percentage` is set for `bbq_disk`, `num_candidates` is ignored. Defaults to ~1% per shard for every 1 million vectors.
9898

9999

100100
`filter`

0 commit comments

Comments
 (0)