adding rank_feature dsl query docs #9927
Conversation
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
AntonEliatra
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kolchfa-aws
added
3 - Tech review
|
@kaushalmahi12 Could you review this PR? Thanks! |
| | `saturation` | Optional | Applies a saturation function to the feature value. Boost grows with value but levels off beyond the `pivot`. (Default function if no other function is provided)| | ||
| | `log` | Optional | Uses a logarithmic scoring function based on the field value. Best for large ranges of values.| | ||
| | `sigmoid` | Optional | Applies a sigmoid (S-shaped) curve to score impact, controlled by `pivot` and `exponent`.| | ||
| | `positive_score_impact` | Optional | When `false`, lower values score higher. Useful for features like price where smaller is better. Defined as part of the mapping. (Default is `true`)| |
There was a problem hiding this comment.
I believe that these functions are applied to field values at query time. If that is the case can we explicitly state these facts ?
|
|
||
| ## Boost parameter | ||
|
|
||
| The `boost` parameter allows you to scale the score contribution of the rank_feature clause. It's especially useful in compound queries such as bool, where you want to control the influence of a feature relative to other conditions. |
There was a problem hiding this comment.
where you want to control the influence of a feature relative to other conditions.
I think we using lot of words which are not defined in the context of this page e,g; feature. If this can be translated into more relatable name in the context of this page it would be great otherwise lets add some brief explanation for the domain specific words.
| } | ||
| ``` | ||
|
|
||
| If the pivot is not provided, approximate geometric mean of all rank_feature values in the index is used. |
There was a problem hiding this comment.
I think this line should be placed in the saturation function definition
Description
adding rank_feature dsl query docs
Version
all
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.