Skip to content

Commit 42847bb

Browse files
committed
[NO ISSUE] Bringing over some good changes from PR #316 to Server
1 parent 12bbd81 commit 42847bb

File tree

1 file changed

+0
-34
lines changed

1 file changed

+0
-34
lines changed

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

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -285,40 +285,6 @@ 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-
322288
[#query-object]
323289
== Query Object
324290

0 commit comments

Comments
 (0)