Skip to content

Commit 33dcc92

Browse files
authored
Mark rescore_vector as generally available (#126038)
* Mark rescore_vector as generally available * Update docs/changelog/126038.yaml
1 parent c54c3af commit 33dcc92

File tree

4 files changed

+8
-3
lines changed

4 files changed

+8
-3
lines changed

docs/changelog/126038.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pr: 126038
2+
summary: Mark `rescore_vector` as generally available
3+
area: Vector Search
4+
type: enhancement
5+
issues: []

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ $$$dense-vector-index-options$$$
288288
: (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.
289289

290290
`rescore_vector`
291-
: (Optional, object) Functionality in [preview]. An optional section that configures automatic vector rescoring on knn queries for the given field. Only applicable to quantized index types.
291+
: (Optional, object) An optional section that configures automatic vector rescoring on knn queries for the given field. Only applicable to quantized index types.
292292
:::::{dropdown} Properties of `rescore_vector`
293293
`oversample`
294294
: (required, float) The amount to oversample the search results by. This value should be greater than `1.0` and less than `10.0` or exactly `0` to indicate no oversampling & rescoring should occur. The higher the value, the more vectors will be gathered and rescored with the raw values per shard.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ A kNN retriever returns top documents from a [k-nearest neighbor search (kNN)](d
198198

199199

200200
`rescore_vector`
201-
: (Optional, object) Functionality in [preview]. Apply oversampling and rescoring to quantized vectors.
201+
: (Optional, object) Apply oversampling and rescoring to quantized vectors.
202202

203203
::::{note}
204204
Rescoring only makes sense for quantized vectors; when [quantization](/reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-quantization) is not used, the original vectors are used for scoring. Rescore option will be ignored for non-quantized `dense_vector` fields.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The filter is a pre-filter, meaning that it is applied **during** the approximat
9898

9999

100100
`rescore_vector`
101-
: (Optional, object) Functionality in [preview]. Apply oversampling and rescoring to quantized vectors.
101+
: (Optional, object) Apply oversampling and rescoring to quantized vectors.
102102

103103
::::{note}
104104
Rescoring only makes sense for quantized vectors; when [quantization](/reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-quantization) is not used, the original vectors are used for scoring. Rescore option will be ignored for non-quantized `dense_vector` fields.

0 commit comments

Comments
 (0)