Skip to content

adding rank_feature dsl query docs #9927

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

Conversation

AntonEliatra
Copy link
Contributor

Description

adding rank_feature dsl query docs

Version

all

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Copy link

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
Copy link
Collaborator

@kaushalmahi12 Could you review this PR? Thanks!

Copy link
Contributor

@kaushalmahi12 kaushalmahi12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just couple of comments around adding more clarity

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@AntonEliatra AntonEliatra requested a review from sumobrian as a code owner July 8, 2025 11:07
@AntonEliatra
Copy link
Contributor Author

@kaushalmahi12 thank you for the review, I have now addressed the comments, please have a look again

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @AntonEliatra! Please see my comments and let me know if you have any questions.

| ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `field` | Required | A `rank_feature` or `rank_features` field that contributes to document scoring.|
| `boost` | Optional | A multiplier applied to the score. Default is `1.0`. Values between 0 and 1 reduce the score, values above 1 amplify it. |
| `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)|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the function sections See [Saturation](#saturation).


## Parameters

| Parameter | Required/Optional | Description |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a "Data type" column here? Some of these are non-obvious.

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Jul 9, 2025
AntonEliatra and others added 2 commits July 9, 2025 17:39
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@kolchfa-aws kolchfa-aws added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress labels Jul 10, 2025
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Editorial review

Signed-off-by: Nathan Bower <nbower@amazon.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @AntonEliatra! Edits applied. LGTM

@natebower natebower removed their assignment Jul 10, 2025
@natebower natebower removed the Editorial review PR: Editorial review in progress label Jul 10, 2025
@natebower natebower merged commit d1a3143 into opensearch-project:main Jul 10, 2025
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 10, 2025
* adding rank_feature dsl query docs

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* addressing PR comments

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* addressing the PR comments

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

Signed-off-by: Nathan Bower <nbower@amazon.com>

---------

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit d1a3143)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws added a commit that referenced this pull request Jul 10, 2025
* adding rank_feature dsl query docs



* addressing PR comments



* Apply suggestions from code review




* addressing the PR comments



* Apply suggestions from code review



---------






(cherry picked from commit d1a3143)

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
@AntonEliatra AntonEliatra deleted the adding-rank_feature-dsl-query-docs branch July 10, 2025 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants