MB-71971: Add explain to custom score queries#2340
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Explain support to custom score queries by emitting a simple explanation node for the post-mutation score, and updates related unit tests to use a scorch-backed index instead of NewMemOnly.
Changes:
- Thread
options.ExplainintoCustomScoreSearcherand, when enabled, replace the hit explanation with"custom_score function result"(value = final mutated score). - Refactor
CustomScoreSearcherscoring into a helper (applyScore) used by bothNextandAdvance. - Update custom query tests to use temporary scorch indexes and add a new explain-focused test.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| search/searcher/search_custom_score.go | Adds an explain flag and wraps the final score in a single explanation node when enabled. |
| search/query/custom_score.go | Passes options.Explain into the custom score searcher construction. |
| search_test.go | Switches custom-query test indexes to scorch-backed on-disk indexes and adds an explain test. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CascadingRadium
approved these changes
Jun 1, 2026
maneuvertomars
approved these changes
Jun 1, 2026
This file contains hidden or 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
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.
explain: truenow have a simple "custom_score function result" message