IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Guide [7.7] » Text analysis » Tokenizer reference » Simple Pattern Split Tokenizer
« Simple Pattern Tokenizer Standard Tokenizer »

Simple Pattern Split Tokenizeredit

The simple_pattern_split tokenizer uses a regular expression to split the input into terms at pattern matches. The set of regular expression features it supports is more limited than the pattern tokenizer, but the tokenization is generally faster.

This tokenizer does not produce terms from the matches themselves. To produce terms from matches using patterns in the same restricted regular expression subset, see the simple_pattern tokenizer.

This tokenizer uses Lucene regular expressions. For an explanation of the supported features and syntax, see Regular Expression Syntax.

The default pattern is the empty string, which produces one term containing the full input. This tokenizer should always be configured with a non-default pattern.

Configurationedit

The simple_pattern_split tokenizer accepts the following parameters:

pattern

A Lucene regular expression, defaults to the empty string.

Example configurationedit

This example configures the simple_pattern_split tokenizer to split the input text on underscores.

PUT my_index
{
  "settings": {
    "analysis": {
      "analyzer": {
        "my_analyzer": {
          "tokenizer": "my_tokenizer"
        }
      },
      "tokenizer": {
        "my_tokenizer": {
          "type": "simple_pattern_split",
          "pattern": "_"
        }
      }
    }
  }
}

POST my_index/_analyze
{
  "analyzer": "my_analyzer",
  "text": "an_underscored_phrase"
}

The above example produces these terms:

[ an, underscored, phrase ]
« Simple Pattern Tokenizer Standard Tokenizer »