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 simple pattern split tokenizer docs #8491

Conversation

AntonEliatra
Copy link
Contributor

Description

add simple pattern split tokenizer docs

Issues Resolved

Part of #1483 addressed in this PR.

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

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

@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 10, 2024
AntonEliatra and others added 2 commits October 16, 2024 17:17
Signed-off-by: Anton Rubin <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws kolchfa-aws assigned kolchfa-aws and unassigned vagimeli Dec 5, 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 labels Dec 5, 2024
kolchfa-aws and others added 3 commits December 5, 2024 14:15
Signed-off-by: Fanit Kolchina <[email protected]>
…om:AntonEliatra/documentation-website into adding-simple-pattern-split-tokenizer-docs
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 @AntonEliatra Editorial review. Thanks!

_analyzers/tokenizers/simple-pattern-split.md Outdated Show resolved Hide resolved
_analyzers/tokenizers/simple-pattern-split.md Outdated Show resolved Hide resolved
_analyzers/tokenizers/simple-pattern-split.md Outdated Show resolved Hide resolved

Parameter | Required/Optional | Data type | Description
:--- | :--- | :--- | :---
`pattern` | Optional | String | The pattern used to split text into tokens specified using a [Lucene regular expression](https://lucene.apache.org/core/9_10_0/core/org/apache/lucene/util/automaton/RegExp.html). Default is an empty string, which returns the input text as one token.
Copy link
Collaborator

Choose a reason for hiding this comment

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

If the tokens are specified, then fine as is. If, however, the pattern is specified, then there should be a comma after "tokens".

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
@kolchfa-aws kolchfa-aws merged commit 595bc13 into opensearch-project:main Dec 9, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 9, 2024
* add simple pattern split tokenizer docs

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]>

* Update _analyzers/tokenizers/simple-pattern-split.md

Signed-off-by: kolchfa-aws <[email protected]>

* Clarification

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]>

---------

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 595bc13)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@AntonEliatra AntonEliatra deleted the adding-simple-pattern-split-tokenizer-docs branch December 9, 2024 18:03
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 Needs SME Waiting on input from subject matter expert
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants