Support Radial Search #1166
Merged
Support Radial Search #1166
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
alex-keeler
requested review from
reta,
Bukhtawar,
dblock,
szczepanczykd,
madhusudhankonda,
saratvemulapalli,
VachaShah and
Xtansia
as code owners
|
Thanks @alex-keeler. Please amend with Please check that these fields are present in https://github.com/opensearch-project/opensearch-api-specification, and maybe even add a test to use these queries as we are working on generating much of this code from spec. |
|
It appears the specification (schemas/_common.yaml#/components/schemas/KnnQuery) is inconsistent with the current implementation of the knn query. It specifies a |
* Generate ml.register_model_group Signed-off-by: Thomas Farr <[email protected]> * Start neural search sample Signed-off-by: Thomas Farr <[email protected]> * Re-generate ShardStatistics Signed-off-by: Thomas Farr <[email protected]> * Re-generate ShardFailure Signed-off-by: Thomas Farr <[email protected]> * Re-generate Result Signed-off-by: Thomas Farr <[email protected]> * Re-generate WriteResponseBase Signed-off-by: Thomas Farr <[email protected]> * Generate ml.delete_model_group Signed-off-by: Thomas Farr <[email protected]> * Generate ml.register_model Signed-off-by: Thomas Farr <[email protected]> * Exclude legacy license from ml namespace Signed-off-by: Thomas Farr <[email protected]> * Generate ml.get_task Signed-off-by: Thomas Farr <[email protected]> * Generate ml.delete_task Signed-off-by: Thomas Farr <[email protected]> * Generate ml.delete_model Signed-off-by: Thomas Farr <[email protected]> * Generate ml.deploy_model Signed-off-by: Thomas Farr <[email protected]> * Generate ml.undeploy_model Signed-off-by: Thomas Farr <[email protected]> * Complete neural search sample Signed-off-by: Thomas Farr <[email protected]> * Generate ml.get_model Signed-off-by: Thomas Farr <[email protected]> * Add changelog entry Signed-off-by: Thomas Farr <[email protected]> * note Signed-off-by: Thomas Farr <[email protected]> * Fix tests Signed-off-by: Thomas Farr <[email protected]> --------- Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]>
Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]>
Add minScore, maxDistance parameters to KnnQuery in order to support Radial Search, which was introduced in OpenSearch 2.14 https://opensearch.org/docs/latest/search-plugins/knn/radial-search-knn/ Signed-off-by: Alex Keeler <[email protected]>
Signed-off-by: alex-keeler <[email protected]> Signed-off-by: Alex Keeler <[email protected]>
…nsearch-project#1167) Signed-off-by: Thomas Farr <[email protected]> (cherry picked from commit 2a362a6)
Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]>
alex-keeler
force-pushed
the
radial-search
branch
from
5f7df70
to
72787ac
Compare
Signed-off-by: alex-keeler <[email protected]>
|
I'm not entirely sure why the WhiteSource Security Check failed, any ideas why it wasn't able to locate the branch? On that note, is there anything else I should do before my pull request is ready to merge? The API spec is up to date and all of the checks have been passing (minus this one). Following up on this since it's been inactive for a couple of weeks. |
The check is very unstable, sorry about that @alex-keeler |
|
I'm hoping this gets (eventually) covered by the code generator, cc: @Xtansia. |
|
Given the somewhat odd nature of the API spec for this particular query (see opensearch-project/opensearch-api-specification#538 (comment)), I'm a tad skeptical that the code generator will be able to handle this case. The java code had already deviated slightly from the API implementation before I touched it. That being said, I haven't looked at the code generator, so I could be wrong. Just a heads up. |
Xtansia
approved these changes
Oct 22, 2024
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Oct 22, 2024
* Generate the ml namespace (#1158) * Generate ml.register_model_group Signed-off-by: Thomas Farr <[email protected]> * Start neural search sample Signed-off-by: Thomas Farr <[email protected]> * Re-generate ShardStatistics Signed-off-by: Thomas Farr <[email protected]> * Re-generate ShardFailure Signed-off-by: Thomas Farr <[email protected]> * Re-generate Result Signed-off-by: Thomas Farr <[email protected]> * Re-generate WriteResponseBase Signed-off-by: Thomas Farr <[email protected]> * Generate ml.delete_model_group Signed-off-by: Thomas Farr <[email protected]> * Generate ml.register_model Signed-off-by: Thomas Farr <[email protected]> * Exclude legacy license from ml namespace Signed-off-by: Thomas Farr <[email protected]> * Generate ml.get_task Signed-off-by: Thomas Farr <[email protected]> * Generate ml.delete_task Signed-off-by: Thomas Farr <[email protected]> * Generate ml.delete_model Signed-off-by: Thomas Farr <[email protected]> * Generate ml.deploy_model Signed-off-by: Thomas Farr <[email protected]> * Generate ml.undeploy_model Signed-off-by: Thomas Farr <[email protected]> * Complete neural search sample Signed-off-by: Thomas Farr <[email protected]> * Generate ml.get_model Signed-off-by: Thomas Farr <[email protected]> * Add changelog entry Signed-off-by: Thomas Farr <[email protected]> * note Signed-off-by: Thomas Farr <[email protected]> * Fix tests Signed-off-by: Thomas Farr <[email protected]> --------- Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]> * Fix copy-paste mistake in NeuralSearch sample (#1161) Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]> * Support Radial Search Add minScore, maxDistance parameters to KnnQuery in order to support Radial Search, which was introduced in OpenSearch 2.14 https://opensearch.org/docs/latest/search-plugins/knn/radial-search-knn/ Signed-off-by: Alex Keeler <[email protected]> * Update CHANGELOG.md Signed-off-by: alex-keeler <[email protected]> Signed-off-by: Alex Keeler <[email protected]> * Update changelog post releasing 2.14.0 (#1162) (#1167) Signed-off-by: Thomas Farr <[email protected]> (cherry picked from commit 2a362a6) * Reduce required release approvals (#1168) Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]> --------- Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]> Signed-off-by: alex-keeler <[email protected]> Co-authored-by: Thomas Farr <[email protected]> (cherry picked from commit 3902aef) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Xtansia
added a commit
that referenced
this pull request
Oct 22, 2024
* Generate the ml namespace (#1158) * Generate ml.register_model_group * Start neural search sample * Re-generate ShardStatistics * Re-generate ShardFailure * Re-generate Result * Re-generate WriteResponseBase * Generate ml.delete_model_group * Generate ml.register_model * Exclude legacy license from ml namespace * Generate ml.get_task * Generate ml.delete_task * Generate ml.delete_model * Generate ml.deploy_model * Generate ml.undeploy_model * Complete neural search sample * Generate ml.get_model * Add changelog entry * note * Fix tests --------- * Fix copy-paste mistake in NeuralSearch sample (#1161) * Support Radial Search Add minScore, maxDistance parameters to KnnQuery in order to support Radial Search, which was introduced in OpenSearch 2.14 https://opensearch.org/docs/latest/search-plugins/knn/radial-search-knn/ * Update CHANGELOG.md * Update changelog post releasing 2.14.0 (#1162) (#1167) (cherry picked from commit 2a362a6) * Reduce required release approvals (#1168) --------- (cherry picked from commit 3902aef) Signed-off-by: Thomas Farr <[email protected]> Signed-off-by: Alex Keeler <[email protected]> Signed-off-by: alex-keeler <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Thomas Farr <[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.
Add minScore, maxDistance parameters to KnnQuery
Description
OpenSearch 2.14 added support for Radial Search. This change added the ability to specify a max_distance or min_score parameter on the knn query, which act as a relevancy threshold for neighboring documents. Exactly one of k, max_distance, or min_score must be provided to the knn query.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.