Skip to content

Commit 5e9a839

Browse files
[DOC-12715] Document New Search Request Params for Search Fine-Tuning (#291)
* [quickfix]: quickfix: strange font problem on diagram (#274) Seems to have been caused by extra space in the label. * [DOC-12610]: Document `nprobe` tweaking * [DOC=12610]: Moved fine-tuning menu entry. [DOC=12610]: Moved the stem declaration; wasn't working in the old position. * [DOC=12610]: Moved and reworded the sections for clarity. Adding link to search-index-params.adoc * [DOC-12715] Add documentation to the JSON search request example and topics around the new added memory-efficient setting and the params object for probe and centroid tuning * [DOC-12715] Adding on to Ray's documentation to provide a link to Search Request Params. * [DOC-12715] Comments from peer review --------- Co-authored-by: Ray Offiah <[email protected]> Co-authored-by: Ray Offiah <[email protected]>
1 parent 507b7b9 commit 5e9a839

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

modules/search/pages/search-request-params.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,40 @@ If you reduce your `ivf_max_codes_pct` value, the Search Service accesses fewer
285285
In the example, the Search Service searches only `0.2%` of the available centroids in your vector data.
286286
|====
287287

288+
[#knn-params]
289+
=== Knn params Object
290+
291+
Use the `params` object inside a `knn` object to fine tune the probes and centroids the Search Services uses and searches while running a Vector Search request.
292+
293+
The `params` object can contain the following properties:
294+
295+
[cols="1,1,1,4"]
296+
|====
297+
|Property |Type |Required? |Description
298+
299+
|ivf_nprobe_pct |Number (percentage) |No a|
300+
301+
Set the `ivf_nprobe_pct` value to control the percentage of probes, or the percentage of clusters, that the Search Service searches during a single Vector Search query.
302+
303+
The Search Service automatically calculates a default `nprobe` percentage based on the vectors in a given partition of your Vector Search index.
304+
For more information about this calculation, see xref:vector-search:fine-tune-vector-search.adoc[].
305+
306+
If you set the value of `ivf_nprobe_pct` higher than this default calculated value, the Search Service will search a higher percentage of clusters in your processed vectors.
307+
This can increase your accuracy and recall for Vector Search, but requires more compute time for each query.
308+
309+
In the example, the Search Service searches only `1%` of the total available clusters.
310+
311+
|ivf_max_codes_pct |Number (percentage out of 100) |No a|
312+
313+
Set the `ivf_max_codes_pct` value to control the maximum number of centroids that the Search Service accesses during a single Vector Search query.
314+
315+
By default, this value is always 100%.
316+
317+
If you reduce your `ivf_max_codes_pct` value, the Search Service accesses fewer centroids, which reduces your Vector Search accuracy and recall, but gives faster compute times for your search.
318+
319+
In the example, the Search Service searches only `0.2%` of the available centroids in your vector data.
320+
|====
321+
288322
[#query-object]
289323
== Query Object
290324

0 commit comments

Comments
 (0)