Explain Function Score Query 8.15 Backport#111864
Merged
john-wagster merged 4 commits intoelastic:8.15from Aug 15, 2024
Merged
Conversation
allowing for a custom explanation to be passed through as part of supporting building a plugin with a custom script score; previously threw an npe
Collaborator
|
Pinging @elastic/es-search-relevance (Team:Search Relevance) |
Collaborator
|
Hi @john-wagster, I've created a changelog YAML for you. |
benwtrent
approved these changes
Aug 15, 2024
Member
benwtrent
left a comment
There was a problem hiding this comment.
Don't need reviews for backports unless something substantial changes :)
|
|
||
| - requires: | ||
| cluster_features: [ "gte_v8.15.1" ] | ||
| reason: "bug fixed where explanations were throwing npe prior to 8.16" |
Member
There was a problem hiding this comment.
Suggested change
| reason: "bug fixed where explanations were throwing npe prior to 8.16" | |
| reason: "bug fixed where explanations were throwing npe prior to 8.15.1" |
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
3 participants
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.
Addressing an NPE found when building a custom plugin leveraging a script.
#109177
This occurs when calling execute on a ScoreScript like this:
Example Returned Hit with the Explanation Customized
{ "_shard" : "[test][0]", "_node" : "6aOP4_Q5SOGIyr4oIxj0TQ", "_index" : "test", "_id" : "2", "_score" : 0.5685853, "_source" : { "important_field" : "foo foo foo" }, "_explanation" : { "value" : 0.5685853, "description" : "function score, product of:", "details" : [ ... { "value" : 3.0, "description" : "min of:", "details" : [ { "value" : 3.0, "description" : "An example optional custom description to explain details for this script's execution; we'll provide a default one if you leave this out.", "details" : [ { "value" : 0.18952844, "description" : "_score: ", "details" : [ { "value" : 0.18952844, "description" : "weight(important_field:foo in 1) [PerFieldSimilarity], result of:", "details" : [ { "value" : 0.18952844, "description" : "score(freq=3.0), computed as boost * idf * tf from:", "details" : [ { "value" : 2.2, "description" : "boost", "details" : [ ] }, { "value" : 0.13353139, "description" : "idf, computed as log(1 + (N - n + 0.5) / (n + 0.5)) from:", "details" : [ { "value" : 3, "description" : "n, number of documents containing term", "details" : [ ] }, { "value" : 3, "description" : "N, total number of documents with field", "details" : [ ] } ] }, { "value" : 0.6451613, "description" : "tf, computed as freq / (freq + k1 * (1 - b + b * dl / avgdl)) from:", "details" : [ { "value" : 3.0, "description" : "freq, occurrences of term within document", "details" : [ ] }, { "value" : 1.2, "description" : "k1, term saturation parameter", "details" : [ ] }, { "value" : 0.75, "description" : "b, length normalization parameter", "details" : [ ] }, { "value" : 3.0, "description" : "dl, length of field", "details" : [ ] }, { "value" : 2.0, "description" : "avgdl, average length of field", "details" : [ ] } ] } ] } ] } ] } ] }, { "value" : 3.4028235E38, "description" : "maxBoost", "details" : [ ] } ] } ] } }What the Hit Would Normally Look Like Without the Custom Explanation
{ "_shard" : "[test][0]", "_node" : "Fg3ne_PXSi2ljhqljA6QOQ", "_index" : "test", "_id" : "2", "_score" : 0.5685853, "_source" : { "important_field" : "foo foo foo" }, "_explanation" : { "value" : 0.5685853, "description" : "function score, product of:", "details" : [ ... { "value" : 3.0, "description" : "min of:", "details" : [ { "value" : 3.0, "description" : "script score function, computed with script:\"Script{type=inline, lang='expert_scripts', idOrCode='pure_df', options={}, params={field=important_field, term=foo}}\"", "details" : [ { "value" : 0.18952844, "description" : "_score: ", "details" : [ { "value" : 0.18952844, "description" : "weight(important_field:foo in 1) [PerFieldSimilarity], result of:", "details" : [ { "value" : 0.18952844, "description" : "score(freq=3.0), computed as boost * idf * tf from:", "details" : [ { "value" : 2.2, "description" : "boost", "details" : [ ] }, { "value" : 0.13353139, "description" : "idf, computed as log(1 + (N - n + 0.5) / (n + 0.5)) from:", "details" : [ { "value" : 3, "description" : "n, number of documents containing term", "details" : [ ] }, { "value" : 3, "description" : "N, total number of documents with field", "details" : [ ] } ] }, { "value" : 0.6451613, "description" : "tf, computed as freq / (freq + k1 * (1 - b + b * dl / avgdl)) from:", "details" : [ { "value" : 3.0, "description" : "freq, occurrences of term within document", "details" : [ ] }, { "value" : 1.2, "description" : "k1, term saturation parameter", "details" : [ ] }, { "value" : 0.75, "description" : "b, length normalization parameter", "details" : [ ] }, { "value" : 3.0, "description" : "dl, length of field", "details" : [ ] }, { "value" : 2.0, "description" : "avgdl, average length of field", "details" : [ ] } ] } ] } ] } ] } ] }, { "value" : 3.4028235E38, "description" : "maxBoost", "details" : [ ] } ] } ] } }