Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Enabling explainability for hybrid query #8645

Open
1 of 4 tasks
martin-gaievski opened this issue Nov 1, 2024 · 0 comments
Open
1 of 4 tasks

[DOC] Enabling explainability for hybrid query #8645

martin-gaievski opened this issue Nov 1, 2024 · 0 comments
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.19.0

Comments

@martin-gaievski
Copy link
Member

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.

Existing documentation page for hybrid query (https://opensearch.org/docs/latest/search-plugins/hybrid-search/) should be updated, the new addition should mention that hybrid query will support the explain. Describe the explain option for hybrid queries, noting that it enables detailed visibility into score composition. When enabled, explain provides a breakdown of how scores from individual subqueries are normalized, combined, and contribute to the overall ranking.

Setup Requirement
To view explain details in responses, users must configure a new response processor within their search pipeline. This configuration is required to process and output the detailed scoring information for hybrid queries.

Usage with Full Query
The explain feature operates only when requested for the entire hybrid query (not for specific document IDs). Include a note that explain is triggered using the explain request parameter at the query level. The response will detail:

Score normalization and combination processes.
Calculations for each subquery’s score and their influence on the final score.
Explain by Document ID
Clarify that requesting explain for a specific document ID will only show the score breakdown at the individual query level, without detailing score normalization or combination. This option provides origin-level scoring insights without the combined explanation.

As development is ongoing we can give only draft of the request/response that are involved into this feature

Version:
Planned to be released in 2.19

What other resources are available?
GH issue: opensearch-project/neural-search#658
RFC for explain in hybrid query feature: opensearch-project/neural-search#905

@martin-gaievski martin-gaievski changed the title [DOC] [DOC] Enabling explainability for hybrid query Nov 1, 2024
@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.19.0
Projects
None yet
Development

No branches or pull requests

2 participants