Skip to content
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

Add limit token filter docs #8159

Merged

Conversation

AntonEliatra
Copy link
Contributor

@AntonEliatra AntonEliatra commented Sep 3, 2024

Description

Add limit token filter docs

Issues Resolved

Closes #8153

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>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Copy link

github-actions bot commented Sep 3, 2024

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 kolchfa-aws assigned vagimeli and unassigned kolchfa-aws Sep 3, 2024
@AntonEliatra AntonEliatra changed the title Add limit toke filter docs Add limit token filter docs Sep 3, 2024
@vagimeli
Copy link
Contributor

vagimeli commented Sep 3, 2024

@udabhas Will you review this PR for technical accuracy? Thank you.

@vagimeli vagimeli added 3 - Tech review PR: Tech review in progress Needs SME Waiting on input from subject matter expert labels Sep 3, 2024
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
@vagimeli
Copy link
Contributor

vagimeli commented Oct 3, 2024

@udabhas Will you review this PR for technical accuracy? Thank you.

@udabhas @varun-lodaya This is a month old. We need tech review approval to move it forward in the documentation process. Please review this week or provide a peer who can review it. Thank you.

AntonEliatra and others added 2 commits October 16, 2024 18:45
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
@kolchfa-aws kolchfa-aws assigned kolchfa-aws and unassigned vagimeli Nov 15, 2024
@kolchfa-aws kolchfa-aws added 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress Needs SME Waiting on input from subject matter expert labels Nov 15, 2024
@kolchfa-aws kolchfa-aws added the backport 2.18 PR: Backport label for 2.18 label Nov 15, 2024
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.

@kolchfa-aws One comment and a few changes. Thanks!

_analyzers/token-filters/index.md Outdated Show resolved Hide resolved
_analyzers/token-filters/limit.md Outdated Show resolved Hide resolved
_analyzers/token-filters/limit.md Outdated Show resolved Hide resolved
:--- | :--- | :--- | :---
`max_token_count` | Optional | Integer | The maximum number of tokens to be generated. Default is `1`.
`consume_all_tokens` | Optional | Boolean | (Expect level setting) Use all tokens from tokenizer, even if result exceeds `max_token_count`. When this parameter is set, the output still only contains the number of tokens specified in `max_token_count`. However, all tokens generated by the tokenizer are processed. Default is `false`.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Line 19: What does "(Expect level setting)" mean?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Expert 😄 Thanks for the catch.

Copy link
Collaborator

Choose a reason for hiding this comment

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

YW, but should be "Expert-level setting" in that case 😄

kolchfa-aws and others added 3 commits December 2, 2024 11:00
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws kolchfa-aws merged commit 1026a84 into opensearch-project:main Dec 2, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 2, 2024
* adding limit token filter docs

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

* removing parameter which is not working #8153

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

* adding consume_all_tokens

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

* Update limit.md

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

* updating parameter table

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

* Doc review

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _analyzers/token-filters/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Fanit Kolchina <kolchfa@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 1026a84)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress analyzers backport 2.18 PR: Backport label for 2.18 Content gap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Token filters - limit [DOC]
4 participants