Skip to content

Commit b005c29

Browse files
committed
[NO ISSUE] Bringing over some good changes from PR #316 to Server
1 parent 4166f94 commit b005c29

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
@@ -271,40 +271,6 @@ If you reduce your `ivf_max_codes_pct` value, the Search Service accesses fewer
271271
In the example, the Search Service searches only `0.2%` of the available centroids in your vector data.
272272
|====
273273

274-
[#knn-params]
275-
=== Knn params Object
276-
277-
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.
278-
279-
The `params` object can contain the following properties:
280-
281-
[cols="1,1,1,4"]
282-
|====
283-
|Property |Type |Required? |Description
284-
285-
|ivf_nprobe_pct |Number (percentage) |No a|
286-
287-
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.
288-
289-
The Search Service automatically calculates a default `nprobe` percentage based on the vectors in a given partition of your Vector Search index.
290-
For more information about this calculation, see xref:vector-search:fine-tune-vector-search.adoc[].
291-
292-
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.
293-
This can increase your accuracy and recall for Vector Search, but requires more compute time for each query.
294-
295-
In the example, the Search Service searches only `1%` of the total available clusters.
296-
297-
|ivf_max_codes_pct |Number (percentage out of 100) |No a|
298-
299-
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.
300-
301-
By default, this value is always 100%.
302-
303-
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.
304-
305-
In the example, the Search Service searches only `0.2%` of the available centroids in your vector data.
306-
|====
307-
308274
[#query-object]
309275
== Query Object
310276

0 commit comments

Comments
 (0)