Skip to content

Commit 09a9156

Browse files
committed
Refactor common params
1 parent e7144de commit 09a9156

File tree

3 files changed

+14
-19
lines changed

3 files changed

+14
-19
lines changed

docs/reference/query-dsl/knn-query.asciidoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,12 +134,8 @@ documents are then scored according to <<dense-vector-similarity, `similarity`>>
134134
and the provided `boost` is applied.
135135
--
136136

137-
`rescore`::
138-
+
139-
--
140-
(Optional, object) Rescoring to apply to quantized vectors.
141-
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-rescore]
142-
--
137+
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-rescore-vector]
138+
143139

144140
`boost`::
145141
+

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,18 +1347,22 @@ Applies the specified <<query-dsl-bool-query, boolean query filter>> to all of t
13471347
according to each retriever's specifications.
13481348
end::rrf-filter[]
13491349

1350-
tag::knn-rescore[]
1350+
tag::knn-rescore-vector[]
1351+
1352+
`rescore_vector`::
1353+
+
1354+
--
1355+
(Optional, object) Functionality in preview:[]. Apply oversampling and rescoring to quantized vectors.
13511356

13521357
NOTE: Rescoring only makes sense for quantized vectors; when <<dense-vector-quantization,quantization>> is not used, the original vectors are used for scoring.
13531358
Rescore option will be ignored for non-quantized `dense_vector` fields.
13541359

1355-
`oversample`::
1360+
`num_candidates_factor`::
13561361
(Required, float)
13571362
+
1358-
Applies the specified oversample factor to the approximate kNN search.
1359-
The approximate kNN search will retrieve the top `k * oversample` candidates per shard,
1360-
and then use the original vectors for rescoring.
1361-
The top `k` rescored candidates will be returned as results.
1363+
Applies the specified oversample factor to the number of candidates on the approximate kNN search.
1364+
The approximate kNN search will retrieve `num_candidates * num_candidates_factor` candidates per shard, and then use the original vectors for rescoring them.
13621365

13631366
See <<dense-vector-knn-search-reranking,oversampling and rescoring quantized vectors>> for details.
1364-
end::knn-rescore[]
1367+
--
1368+
end::knn-rescore-vector[]

docs/reference/search/retriever.asciidoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -224,12 +224,7 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-filter]
224224
+
225225
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-similarity]
226226

227-
`rescore`::
228-
+
229-
--
230-
(Optional, object) Rescoring to apply to quantized vectors.
231-
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-rescore]
232-
--
227+
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=knn-rescore-vector]
233228

234229
===== Restrictions
235230

0 commit comments

Comments
 (0)