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 word delimiter graph token filter docs #8454 #8468

Conversation

AntonEliatra
Copy link
Contributor

Description

add word delimiter graph token filter docs

Issues Resolved

Closes #8454

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.

Copy link

github-actions bot commented Oct 4, 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.

@vagimeli
Copy link
Contributor

vagimeli commented Oct 8, 2024

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

@vagimeli vagimeli added 3 - Tech review PR: Tech review in progress Needs SME Waiting on input from subject matter expert Content gap analyzers labels Oct 8, 2024
Signed-off-by: Anton Rubin <[email protected]>
@kolchfa-aws kolchfa-aws assigned kolchfa-aws and unassigned vagimeli Nov 21, 2024
@kolchfa-aws kolchfa-aws added 5 - Editorial review PR: Editorial review in progress backport 2.18 PR: Backport label for 2.18 and removed 3 - Tech review PR: Tech review in progress Needs SME Waiting on input from subject matter expert labels Nov 21, 2024
Signed-off-by: Fanit Kolchina <[email protected]>
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 Please see my comments and changes and let me know if you have any questions. Thanks!

_analyzers/token-filters/index.md Outdated Show resolved Hide resolved
_analyzers/token-filters/word-delimiter-graph.md Outdated Show resolved Hide resolved
_analyzers/token-filters/word-delimiter-graph.md Outdated Show resolved Hide resolved
_analyzers/token-filters/word-delimiter-graph.md Outdated Show resolved Hide resolved
| Remove leading or trailing delimiters | Removes delimiters at the start or end of tokens. | `Z99++'Decoder'`| `Z99`, `Decoder` |
| Split tokens at letter case transitions | Splits tokens when there is a transition between uppercase and lowercase letters. | `OpenSearch` | `Open`, `Search` |
| Split tokens at letter-number transitions | Splits tokens when there is a transition between letters and numbers. | `T1000` | `T`, `1000` |
| Remove the English possessive ('s) | Removes the possessive ('s) from the end of tokens. | `John's` | `John` |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would argue that the Action and Description columns here are redundant in providing the same information with slightly different phrasing. Are both necessary?

_analyzers/token-filters/word-delimiter-graph.md Outdated Show resolved Hide resolved
To illustrate the filter differences, consider the input text `Pro-XT500`.

<!-- vale off-->
### word_delimiter_graph
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same comment re: underscores

- `XT500` (position 2)
- `ProXT500` (position 1, `positionLength`: 2)

The `positionLength` attribute ensures a valid graph for advanced queries.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"ensures the production of a valid graph to be used in advanced queries"?

The `positionLength` attribute ensures a valid graph for advanced queries.

<!-- vale off-->
### word_delimiter
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same comment re: underscores

_analyzers/token-filters/word-delimiter-graph.md Outdated Show resolved Hide resolved
kolchfa-aws and others added 3 commits December 3, 2024 09:05
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws kolchfa-aws merged commit 3f756d2 into opensearch-project:main Dec 3, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 3, 2024
* add word delimiter graph token filter docs #8454

Signed-off-by: Anton Rubin <[email protected]>

* updating parameter table

Signed-off-by: Anton Rubin <[email protected]>

* Doc review

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* More merge conflicts

Signed-off-by: Fanit Kolchina <[email protected]>

* typo fix

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Anton Rubin <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 3f756d2)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@AntonEliatra AntonEliatra deleted the adding-word_delimiter_graph-token-filter-docs branch December 3, 2024 14:54
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 - word_delimiter_graph [DOC]
4 participants