Add documentation for knn option#88667
Conversation
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-search (Team:Search) |
| `0` and `1.0` decreases the score. | ||
| ==== | ||
|
|
||
| experimental::[] |
There was a problem hiding this comment.
Is the newknn section within _search API is also experimental?
I was under impression that it is not experimental anymore.
cc @giladgal
There was a problem hiding this comment.
In our discussions, we said that integrating ANN into the _search endpoint is a separate step from making the feature GA. Before GA, we still have a few items to tackle (like adding telemetry, improving index performance, etc.)
| [[search-api-knn]] | ||
| `knn`:: | ||
| (Required, object) Defines the kNN query to run. | ||
| + |
There was a problem hiding this comment.
Should we include a reference here to the approximate-knn section of the knn-search.asciidoc? I was thinking if a user stumble on this page, they would not know that we have mode details on knn search.
There was a problem hiding this comment.
Good idea, I'll add a link. I also realized this should be "Optional" instead of "Required".
mayya-sharipova
left a comment
There was a problem hiding this comment.
@jtibshirani Thanks, this LGTM. I left two small comments.
|
Thanks for the review! I'm going to merge, but happy to discuss anything further. |
This change adds docs for the new search
knnoption:knnoption to_searchAPI docs._searchendpoint instead of_knn_searchendpoint. Move relevant information from the_knn_searchAPIdocs to this guide, like the filtering example.
index_options(justseemed nice to have, not core to this change).
The PR doesn't deprecate the
_knn_searchendpoint yet.Addresses #87625.