OpenSearch/docs/reference/analysis/tokenizers
Itamar Syn-Hershko 5f172b6795 [Feature] Adding a char_group tokenizer (#24186)
=== Char Group Tokenizer

The `char_group` tokenizer breaks text into terms whenever it encounters
a
character which is in a defined set. It is mostly useful for cases where
a simple
custom tokenization is desired, and the overhead of use of the
<<analysis-pattern-tokenizer, `pattern` tokenizer>>
is not acceptable.

=== Configuration

The `char_group` tokenizer accepts one parameter:

`tokenize_on_chars`::
    A string containing a list of characters to tokenize the string on.
Whenever a character
    from this list is encountered, a new token is started. Also supports
escaped values like `\\n` and `\\f`,
    and in addition `\\s` to represent whitespace, `\\d` to represent
digits and `\\w` to represent letters.
    Defaults to an empty list.

=== Example output

```The 2 QUICK Brown-Foxes jumped over the lazy dog's bone for $2```

When the configuration `\\s-:<>` is used for `tokenize_on_chars`, the
above sentence would produce the following terms:

```[ The, 2, QUICK, Brown, Foxes, jumped, over, the, lazy, dog's, bone,
for, $2 ]```
2018-05-22 16:26:31 +02:00
..
chargroup-tokenizer.asciidoc [Feature] Adding a char_group tokenizer (#24186) 2018-05-22 16:26:31 +02:00
classic-tokenizer.asciidoc Remove wait_for_status=yellow from the docs 2016-07-15 16:02:07 -04:00
edgengram-tokenizer.asciidoc Default to one shard (#30539) 2018-05-14 12:22:35 -04:00
keyword-tokenizer.asciidoc
letter-tokenizer.asciidoc
lowercase-tokenizer.asciidoc Update lowercase-tokenizer.asciidoc (#21896) 2016-12-02 10:49:51 -05:00
ngram-tokenizer.asciidoc Add limits for ngram and shingle settings (#27211) 2017-11-07 08:14:55 -05:00
pathhierarchy-tokenizer.asciidoc Remove wait_for_status=yellow from the docs 2016-07-15 16:02:07 -04:00
pattern-tokenizer.asciidoc [Docs] Fix typo in pattern-tokenizer.asciidoc (#25626) 2017-07-13 18:43:48 +02:00
simplepattern-tokenizer.asciidoc Update experimental labels in the docs (#25727) 2017-07-18 14:06:22 +02:00
simplepatternsplit-tokenizer.asciidoc Update experimental labels in the docs (#25727) 2017-07-18 14:06:22 +02:00
standard-tokenizer.asciidoc Remove wait_for_status=yellow from the docs 2016-07-15 16:02:07 -04:00
thai-tokenizer.asciidoc
uaxurlemail-tokenizer.asciidoc Remove wait_for_status=yellow from the docs 2016-07-15 16:02:07 -04:00
whitespace-tokenizer.asciidoc Add configurable `maxTokenLength` parameter to whitespace tokenizer (#26749) 2017-09-25 17:21:19 +02:00