-
Notifications
You must be signed in to change notification settings - Fork 472
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Anton Rubin <[email protected]>
- Loading branch information
1 parent
76486a4
commit 47f85a2
Showing
2 changed files
with
106 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
--- | ||
layout: default | ||
title: Whitespace tokenizer | ||
parent: Tokenizers | ||
nav_order: 160 | ||
--- | ||
|
||
# Whitespace tokenizer | ||
|
||
The `whitespace` tokenizer splits text based purely on whitespace characters (like spaces, tabs, and newlines). It treats each word separated by whitespace as a token, without performing any additional analysis or normalization like lowercasing or punctuation removal. | ||
|
||
## Example usage | ||
|
||
The following example request creates a new index named `my_index` and configures an analyzer with `whitespace` tokenizer: | ||
|
||
``` | ||
PUT /my_index | ||
{ | ||
"settings": { | ||
"analysis": { | ||
"tokenizer": { | ||
"whitespace_tokenizer": { | ||
"type": "whitespace" | ||
} | ||
}, | ||
"analyzer": { | ||
"my_whitespace_analyzer": { | ||
"type": "custom", | ||
"tokenizer": "whitespace_tokenizer" | ||
} | ||
} | ||
} | ||
}, | ||
"mappings": { | ||
"properties": { | ||
"content": { | ||
"type": "text", | ||
"analyzer": "my_whitespace_analyzer" | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## Generated tokens | ||
|
||
Use the following request to examine the tokens generated using the created analyzer: | ||
|
||
```json | ||
POST /my_index/_analyze | ||
{ | ||
"analyzer": "my_whitespace_analyzer", | ||
"text": "OpenSearch is fast! Really fast." | ||
} | ||
``` | ||
{% include copy-curl.html %} | ||
|
||
The response contains the generated tokens: | ||
|
||
```json | ||
{ | ||
"tokens": [ | ||
{ | ||
"token": "OpenSearch", | ||
"start_offset": 0, | ||
"end_offset": 10, | ||
"type": "word", | ||
"position": 0 | ||
}, | ||
{ | ||
"token": "is", | ||
"start_offset": 11, | ||
"end_offset": 13, | ||
"type": "word", | ||
"position": 1 | ||
}, | ||
{ | ||
"token": "fast!", | ||
"start_offset": 14, | ||
"end_offset": 19, | ||
"type": "word", | ||
"position": 2 | ||
}, | ||
{ | ||
"token": "Really", | ||
"start_offset": 20, | ||
"end_offset": 26, | ||
"type": "word", | ||
"position": 3 | ||
}, | ||
{ | ||
"token": "fast.", | ||
"start_offset": 27, | ||
"end_offset": 32, | ||
"type": "word", | ||
"position": 4 | ||
} | ||
] | ||
} | ||
``` | ||
|
||
## Configuration | ||
|
||
The `whitespace` tokenizer can be configured with parameter `max_token_length` which sets the maximum length of the produced token. If this length is exceeded, the token is split into multiple tokens at length configured in `max_token_length`. Default is `255` (Integer, _Optional_) | ||
|