Tokenizers (standard, whitespace, pattern) in Elasticsearch - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does the standard tokenizer do in Elasticsearch?

The standard tokenizer breaks text into terms on word boundaries, using the Unicode Text Segmentation algorithm. It removes most punctuation and splits text into words.

beginner

How does the whitespace tokenizer split text?

The whitespace tokenizer splits text only on whitespace characters like spaces, tabs, and newlines. It keeps punctuation as part of the tokens.

intermediate

What is the main feature of the pattern tokenizer?

The pattern tokenizer splits text using a regular expression pattern you provide. It allows custom splitting rules based on the pattern.

beginner

Example: What tokens does the whitespace tokenizer produce from the text "Hello, world! Welcome to Elasticsearch."?

It produces tokens: ["Hello,", "world!", "Welcome", "to", "Elasticsearch."] because it splits only on spaces and keeps punctuation.

intermediate

Why might you choose the pattern tokenizer over the standard tokenizer?

You choose the pattern tokenizer when you need custom splitting rules that the standard tokenizer can't handle, like splitting on special characters or complex patterns.

Which tokenizer splits text only on whitespace characters?

A Standard tokenizer

B Whitespace tokenizer

C Pattern tokenizer

D Keyword tokenizer

The whitespace tokenizer splits text only on spaces, tabs, and newlines.

What does the standard tokenizer use to split text?

A Unicode Text Segmentation algorithm

B Whitespace only

C Custom regex pattern

D No splitting, keeps whole text

The standard tokenizer uses the Unicode Text Segmentation algorithm to split text on word boundaries.

Which tokenizer allows you to define your own splitting rules with a regex?

A Standard tokenizer

B Whitespace tokenizer

C Simple tokenizer

D Pattern tokenizer

The pattern tokenizer splits text based on a user-defined regular expression.

If you want to keep punctuation attached to words, which tokenizer is best?

A Standard tokenizer

B Pattern tokenizer

C Whitespace tokenizer

D Letter tokenizer

The whitespace tokenizer keeps punctuation because it only splits on whitespace.

What is a key difference between the standard and whitespace tokenizers?

A Standard tokenizer removes punctuation and splits on word boundaries

B Whitespace tokenizer removes punctuation

C Whitespace tokenizer uses regex patterns

D Standard tokenizer splits only on spaces

The standard tokenizer removes punctuation and splits on word boundaries, unlike the whitespace tokenizer.

Explain how the standard, whitespace, and pattern tokenizers differ in how they split text.

Think about what characters each tokenizer uses to decide where to split.

Describe a situation where you would prefer to use the pattern tokenizer instead of the standard tokenizer.

Consider when default word splitting is not enough.

Practice

1. Which Elasticsearch tokenizer splits text by spaces only, keeping punctuation as part of tokens?

easy

A. standard tokenizer

B. whitespace tokenizer

C. pattern tokenizer

D. keyword tokenizer

Solution

1. Step 1: Understand whitespace tokenizer behavior

   The whitespace tokenizer splits text only at spaces and keeps punctuation inside tokens.

2. Step 2: Compare with other tokenizers

   The standard tokenizer removes punctuation, and the pattern tokenizer splits by regex patterns, so they behave differently.

3. Final Answer:

   whitespace tokenizer -> Option B

4. Quick Check:

   Spaces split tokens only = whitespace tokenizer [OK]

Hint: Whitespace tokenizer splits only on spaces, keeps punctuation [OK]

Common Mistakes:

• Confusing standard tokenizer with whitespace tokenizer
• Thinking pattern tokenizer splits only on spaces
• Assuming keyword tokenizer splits text

2. Which of the following is the correct JSON syntax to define a pattern tokenizer that splits text on commas?

easy

A. { "tokenizer": "pattern", "pattern": ',' }

B. { 'tokenizer': 'pattern', 'pattern': ',' }

C. { "tokenizer": "pattern", pattern: "," }

D. { "tokenizer": "pattern", "pattern": "," }

Solution

1. Step 1: Identify correct JSON string escaping

   In JSON, double quotes inside strings must be escaped with a backslash, so the comma pattern must be inside escaped quotes.

2. Step 2: Check each option for proper escaping

   { "tokenizer": "pattern", "pattern": "," } correctly shows the pattern as a string with comma inside quotes.

3. Final Answer:

   { "tokenizer": "pattern", "pattern": "," } -> Option D

4. Quick Check:

   Proper JSON escaping for pattern string = { "tokenizer": "pattern", "pattern": "," } [OK]

Hint: Escape quotes inside JSON strings with backslash [OK]

Common Mistakes:

• Not escaping quotes inside JSON strings
• Using single quotes instead of double quotes
• Missing commas or braces in JSON

3. Given the text "Hello, world! Welcome to Elasticsearch.", what tokens does the standard tokenizer produce?

medium

A. ["Hello", "world!", "Welcome", "to", "Elasticsearch"]

B. ["Hello,", "world!", "Welcome", "to", "Elasticsearch."]

C. ["Hello", "world", "Welcome", "to", "Elasticsearch"]

D. ["Hello", "world", "Welcome", "to", "Elasticsearch."]

Solution

1. Step 1: Understand standard tokenizer behavior

   The standard tokenizer splits text by word boundaries and removes punctuation from tokens.

2. Step 2: Apply tokenizer to given text

   It splits "Hello," into "Hello", "world!" into "world", and removes punctuation marks like commas and exclamation points.

3. Final Answer:

   ["Hello", "world", "Welcome", "to", "Elasticsearch"] -> Option C

4. Quick Check:

   Standard tokenizer removes punctuation = ["Hello", "world", "Welcome", "to", "Elasticsearch"] [OK]

Hint: Standard tokenizer removes punctuation, returns clean words [OK]

Common Mistakes:

• Including punctuation in tokens with standard tokenizer
• Confusing output with whitespace tokenizer
• Assuming pattern tokenizer output without pattern

4. You defined a pattern tokenizer with pattern \W+ but it does not split the text as expected. What is the likely issue?

medium

A. The pattern is not properly escaped in JSON

B. Pattern tokenizer cannot use regex

C. Whitespace tokenizer should be used instead

D. Standard tokenizer must be enabled first

Solution

1. Step 1: Check pattern escaping in JSON

   Regex patterns with backslashes must be double escaped in JSON strings, so \W+ should be written as \\W+.

2. Step 2: Understand tokenizer requirements

   If pattern is not escaped properly, the tokenizer won't interpret it as intended, causing wrong splits.

3. Final Answer:

   The pattern is not properly escaped in JSON -> Option A

4. Quick Check:

   Regex backslash must be double escaped in JSON [OK]

Hint: Double escape backslashes in regex patterns for JSON [OK]

Common Mistakes:

• Using single backslash in JSON regex pattern
• Confusing tokenizer types
• Assuming pattern tokenizer needs enabling

5. You want to index a text field so that tokens are split on commas and semicolons only, keeping spaces and punctuation inside tokens. Which tokenizer configuration should you use?

hard

A. Use a pattern tokenizer with pattern [,;]

B. Use the standard tokenizer

C. Use the whitespace tokenizer

D. Use a pattern tokenizer with pattern \s+

Solution

1. Step 1: Identify tokenizer that splits on specific characters

   The pattern tokenizer allows splitting text by a custom regex pattern, so you can specify commas and semicolons.

2. Step 2: Confirm pattern matches commas and semicolons only

   The pattern [,;] matches commas or semicolons, splitting tokens at those characters but keeping spaces and other punctuation inside tokens.

3. Final Answer:

   Use a pattern tokenizer with pattern [,;] -> Option A

4. Quick Check:

   Pattern tokenizer with custom split chars = Use a pattern tokenizer with pattern [,;] [OK]

Hint: Pattern tokenizer splits by your regex pattern [OK]

Common Mistakes:

• Using whitespace tokenizer which splits on spaces
• Using standard tokenizer which removes punctuation
• Using wrong regex pattern for splitting