Adds Documentation for dynamic query parameters for kNN search request #7761
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shatejas
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
shatejas
force-pushed
the
main
branch
2 times, most recently
from
b1b17b6 to
70998f0
Compare
Signed-off-by: Tejas Shah <[email protected]>
hdhalter
added
release-notes
kolchfa-aws
reviewed
Jul 19, 2024
Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
reviewed
Jul 19, 2024
Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
reviewed
Jul 19, 2024
There was a problem hiding this comment.
Thank you, @shatejas! Some suggestions and a couple of questions.
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]>
kolchfa-aws
reviewed
Jul 22, 2024
kolchfa-aws
reviewed
Jul 22, 2024
|
@shatejas A couple of more suggestions and then we can move the PR to editorial review. Thanks! |
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]>
@kolchfa-aws Applied the suggestions. Thanks! |
natebower
reviewed
Jul 22, 2024
There was a problem hiding this comment.
@shatejas @kolchfa-aws Please see my changes and let me know if you have any questions. Thanks!
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
reviewed
Jul 22, 2024
kolchfa-aws
reviewed
Jul 22, 2024
Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
approved these changes
Jul 22, 2024
hdhalter
added
3 - Done
leanneeliatra
pushed a commit
to leanneeliatra/opensearch-documentation-website-forl
that referenced
this pull request
Jul 24, 2024
opensearch-project#7761) * Adds documentation for dynamic query parameters Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Signed-off-by: kolchfa-aws <[email protected]> * Update _search-plugins/knn/approximate-knn.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Tejas Shah <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: [email protected] <[email protected]>
sandervandegeijn
pushed a commit
to sandervandegeijn/documentation-website
that referenced
this pull request
Jul 30, 2024
opensearch-project#7761) * Adds documentation for dynamic query parameters Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Signed-off-by: kolchfa-aws <[email protected]> * Update _search-plugins/knn/approximate-knn.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Update _search-plugins/knn/approximate-knn.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Tejas Shah <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Tejas Shah <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sander van de Geijn <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Knn is introducing dynamic query parameters ef_search and nprobes to give an ability to improve the recall if the user desires. This adds documentation for the same
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
Closes #7756
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
2.16
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.