[DOCS] Document script_score float precision limit
#49402
Merged
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
Scores produced by the `script_score` function are stored as positive, 32-bit floats in the `_score` field. This updates an existing admonition to document the 32-bits of precision limit.
jrodewig
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-search (:Search/Search) |
jrodewig
commented
Nov 20, 2019
Comment on lines
161
to
162
| As a result, scores are limited to 32-bits of precision. Larger numbers will | ||
| lose precision during storage. |
There was a problem hiding this comment.
I waiver over whether these sentences are needed. Any feedback appreciated!
There was a problem hiding this comment.
Maybe we should clarify that all scores are 32-bit floats in Elasticsearch, this is not specific to this query. Then if a script_score produces a value that has greater accuracy than a 32-bit float, it will be automatically converted to the nearest 32-bit float.
Unrelated note: I find the word "storage" possibly confusing since we don't store scores on disk, which is what some users might think this statement implies.
jrodewig
added a commit
that referenced
this pull request
Nov 21, 2019
All document scores are positive 32-bit floating point numbers. However, this wasn't previously documented. This can result in surprising behavior, such as precision loss, for users when customizing scores using the function score query. This commit updates an existing admonition in the function score query docs to document the 32-bits precision limit. It also updates the search API reference docs to note that `_score` is a 32-bit float.
jrodewig
added a commit
that referenced
this pull request
Nov 21, 2019
All document scores are positive 32-bit floating point numbers. However, this wasn't previously documented. This can result in surprising behavior, such as precision loss, for users when customizing scores using the function score query. This commit updates an existing admonition in the function score query docs to document the 32-bits precision limit. It also updates the search API reference docs to note that `_score` is a 32-bit float.
jrodewig
added a commit
that referenced
this pull request
Nov 21, 2019
All document scores are positive 32-bit floating point numbers. However, this wasn't previously documented. This can result in surprising behavior, such as precision loss, for users when customizing scores using the function score query. This commit updates an existing admonition in the function score query docs to document the 32-bits precision limit. It also updates the search API reference docs to note that `_score` is a 32-bit float.
jrodewig
added a commit
that referenced
this pull request
Nov 21, 2019
All document scores are positive 32-bit floating point numbers. However, this wasn't previously documented. This can result in surprising behavior, such as precision loss, for users when customizing scores using the function score query. This commit updates an existing admonition in the function score query docs to document the 32-bits precision limit.
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.
Scores produced by the
script_scorefunction are stored as positive, 32-bit floats in the_scorefield.This updates an existing admonition in the function score query docs to document the 32-bits of precision limit.
Closes #48845.