add support for scored named queries by Dharin-shah · Pull Request #11626 · opensearch-project/OpenSearch

Dharin-shah · 2023-12-17T19:03:15Z

Description

Opensearch already support labelling the queries, that returns as a list in the returned results, of which query it matched. However one of the use case while doing hybrid search with query text and dense vector is to determine individual scores for each query type. At GetYourGuide, this is very useful in further analysis and building offline model to generate better weights for ranking score. Hence adding this feature that sends the client to add the score for each matched query.

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)
Public documentation issue/PR created

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.

Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com>

github-actions · 2023-12-17T19:11:29Z

❌ Gradle check result for 16b7c19: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-12-17T19:13:21Z

❌ Gradle check result for 3aef42e: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-12-17T19:24:55Z

Compatibility status:

Checks if related components are compatible with change 9920c36

Incompatible components

Incompatible components: [https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/performance-analyzer.git]

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/security.git]

Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com>

github-actions · 2024-02-03T11:09:51Z

❕ Gradle check result for ffdf852: UNSTABLE

TEST FAILURES:

      1 org.opensearch.remotestore.RemoteIndexPrimaryRelocationIT.testPrimaryRelocationWhileIndexing
      1 org.opensearch.action.admin.cluster.node.tasks.ResourceAwareTasksTests.testTaskResourceTrackingDuringTaskCancellation

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

Dharin-shah · 2024-02-04T16:30:38Z

#5329
#9191
Flaky tests issues reported already

@msfroh possible to take a look and merge this is all good, thanks 🙏

Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com>

github-actions · 2024-02-05T18:54:07Z

❌ Gradle check result for 2937d8e: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com>

github-actions · 2024-02-06T06:22:52Z

❕ Gradle check result for 9920c36: UNSTABLE

TEST FAILURES:

      3 org.opensearch.remotestore.RemoteIndexPrimaryRelocationIT.testPrimaryRelocationWhileIndexing

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

msfroh

Sorry for the delay in getting back on this -- it looks good. Thanks a lot @Dharin-shah!

opensearch-trigger-bot · 2024-02-06T18:03:04Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-11626-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 52b27f47bca5b3ab52cab237542f32c307d203b4
# Push it to GitHub
git push --set-upstream origin backport/backport-11626-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-11626-to-2.x.

reta · 2024-02-06T19:06:11Z

@Dharin-shah could you please backport to 2.x manually?

Opensearch already support labelling the queries, that returns as a list in the returned results, of which query it matched. However one of the use case while doing hybrid search with query text and dense vector is to determine individual scores for each query type. This is very useful in further analysis and building offline model to generate better weights for ranking score. Hence adding this feature that sends the client to add the score for each matched query. --------- Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com> Co-authored-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> (cherry picked from commit 52b27f4)

Opensearch already support labelling the queries, that returns as a list in the returned results, of which query it matched. However one of the use case while doing hybrid search with query text and dense vector is to determine individual scores for each query type. This is very useful in further analysis and building offline model to generate better weights for ranking score. Hence adding this feature that sends the client to add the score for each matched query. --------- Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com> Co-authored-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> (cherry picked from commit 52b27f4) Signed-off-by: Andrew Ross <andrross@amazon.com>

andrross · 2024-02-22T00:15:27Z

@reta @Dharin-shah I've opened the backport in #12427

* Add support for scored named queries (#11626) Opensearch already support labelling the queries, that returns as a list in the returned results, of which query it matched. However one of the use case while doing hybrid search with query text and dense vector is to determine individual scores for each query type. This is very useful in further analysis and building offline model to generate better weights for ranking score. Hence adding this feature that sends the client to add the score for each matched query. --------- Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com> Co-authored-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> (cherry picked from commit 52b27f4) Signed-off-by: Andrew Ross <andrross@amazon.com> * Update version checks Signed-off-by: Andrew Ross <andrross@amazon.com> * Update test version guard Co-authored-by: Andriy Redko <drreta@gmail.com> Signed-off-by: Andrew Ross <andrross@amazon.com> --------- Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com> Signed-off-by: Andrew Ross <andrross@amazon.com> Co-authored-by: Dharin Shah <Dharin-shah@users.noreply.github.com> Co-authored-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Co-authored-by: Andriy Redko <drreta@gmail.com>

Opensearch already support labelling the queries, that returns as a list in the returned results, of which query it matched. However one of the use case while doing hybrid search with query text and dense vector is to determine individual scores for each query type. This is very useful in further analysis and building offline model to generate better weights for ranking score. Hence adding this feature that sends the client to add the score for each matched query. --------- Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com> Co-authored-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com>

Opensearch already support labelling the queries, that returns as a list in the returned results, of which query it matched. However one of the use case while doing hybrid search with query text and dense vector is to determine individual scores for each query type. This is very useful in further analysis and building offline model to generate better weights for ranking score. Hence adding this feature that sends the client to add the score for each matched query. --------- Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com> Co-authored-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

add support for scored named queries

16b7c19

Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com>

Dharin-shah mentioned this pull request Dec 17, 2023

return score with named queries #11549

Closed

8 tasks

fix changelog with correct PR reference

3aef42e

Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com>

fix spotless check in opensearch core

5f7740e

Signed-off-by: Dharin Shah <8616130+Dharin-shah@users.noreply.github.com>

Dharin-shah marked this pull request as ready for review December 17, 2023 21:05

Merge branch 'main' into add-support-for-scored-named-queries

2937d8e

Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com>

Merge branch 'main' into add-support-for-scored-named-queries

9920c36

Signed-off-by: Dharin Shah <Dharin-shah@users.noreply.github.com>

msfroh approved these changes Feb 6, 2024

View reviewed changes

msfroh merged commit 52b27f4 into opensearch-project:main Feb 6, 2024

msfroh added the backport 2.x Backport to 2.x branch label Feb 6, 2024

opensearch-trigger-bot bot added the backport-failed label Feb 6, 2024

This was referenced Feb 7, 2024

[Forwardport] Move 2.x version to 2.13.0 (#12227) #12230

Merged

Fix 350_matched_queries.yml tests while awaiting for backport #12232

Merged

reta mentioned this pull request Feb 15, 2024

Named queries should return their internal score as well #7883

Closed

7 tasks

BrewTestBot mentioned this pull request Feb 21, 2024

opensearch 2.12.0 Homebrew/homebrew-core#163463

Merged

andrross mentioned this pull request Feb 24, 2024

[DOC] Document scored named query behavior opensearch-project/documentation-website#6514

Closed

4 tasks

saimedhi mentioned this pull request Mar 13, 2024

[BUG]Search API spec is missing include_named_queries_score param opensearch-project/opensearch-api-specification#200

Closed

saimedhi mentioned this pull request Mar 20, 2024

Added include_named_queries_score param in Search API and primary_only in Forcemerge API opensearch-project/opensearch-api-specification#203

Merged

BrewTestBot mentioned this pull request Apr 3, 2024

opensearch 2.13.0 Homebrew/homebrew-core#167852

Merged

johtani mentioned this pull request Nov 27, 2025

[RFC] Support Sub Query Raw Scores in Hybrid Search opensearch-project/neural-search#1419

Open

briggySmalls mentioned this pull request Nov 28, 2025

[FEATURE] Support include_named_queries_score to parsed scores of named queries opensearch-project/opensearch-java#1805

Open

3 tasks

sam-briggs-depop mentioned this pull request Nov 28, 2025

[FEATURE] matched_queries can include scores opensearch-project/opensearch-api-specification#998

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add support for scored named queries#11626

add support for scored named queries#11626
msfroh merged 35 commits intoopensearch-project:mainfrom
Dharin-shah:add-support-for-scored-named-queries

Dharin-shah commented Dec 17, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Dec 17, 2023

Uh oh!

github-actions bot commented Dec 17, 2023

Uh oh!

github-actions bot commented Dec 17, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Feb 3, 2024

Uh oh!

Dharin-shah commented Feb 4, 2024

Uh oh!

github-actions bot commented Feb 5, 2024

Uh oh!

github-actions bot commented Feb 6, 2024

Uh oh!

msfroh left a comment

Uh oh!

opensearch-trigger-bot bot commented Feb 6, 2024

Uh oh!

reta commented Feb 6, 2024

Uh oh!

andrross commented Feb 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Dharin-shah commented Dec 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

github-actions bot commented Dec 17, 2023

Uh oh!

github-actions bot commented Dec 17, 2023

Uh oh!

github-actions bot commented Dec 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Compatibility status:

Incompatible components

Skipped components

Compatible components

Uh oh!

github-actions bot commented Feb 3, 2024

Uh oh!

Dharin-shah commented Feb 4, 2024

Uh oh!

github-actions bot commented Feb 5, 2024

Uh oh!

github-actions bot commented Feb 6, 2024

Uh oh!

msfroh left a comment

Choose a reason for hiding this comment

Uh oh!

opensearch-trigger-bot bot commented Feb 6, 2024

Uh oh!

reta commented Feb 6, 2024

Uh oh!

andrross commented Feb 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Dharin-shah commented Dec 17, 2023 •

edited

Loading

github-actions bot commented Dec 17, 2023 •

edited

Loading