-
Notifications
You must be signed in to change notification settings - Fork 500
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add lowercase tokenizer docs (#8497)
* add lowercase tokenizer docs Signed-off-by: Anton Rubin <[email protected]> * Doc review 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]>
- Loading branch information
1 parent
b203c4c
commit 68a8af5
Showing
1 changed file
with
93 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
--- | ||
layout: default | ||
title: Lowercase | ||
parent: Tokenizers | ||
nav_order: 70 | ||
--- | ||
|
||
# Lowercase tokenizer | ||
|
||
The `lowercase` tokenizer breaks text into terms at white space and then lowercases all the terms. Functionally, this is identical to configuring a `letter` tokenizer with a `lowercase` token filter. However, using a `lowercase` tokenizer is more efficient because the tokenizer actions are performed in a single step. | ||
|
||
## Example usage | ||
|
||
The following example request creates a new index named `my-lowercase-index` and configures an analyzer with a `lowercase` tokenizer: | ||
|
||
```json | ||
PUT /my-lowercase-index | ||
{ | ||
"settings": { | ||
"analysis": { | ||
"tokenizer": { | ||
"my_lowercase_tokenizer": { | ||
"type": "lowercase" | ||
} | ||
}, | ||
"analyzer": { | ||
"my_lowercase_analyzer": { | ||
"type": "custom", | ||
"tokenizer": "my_lowercase_tokenizer" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
{% include copy-curl.html %} | ||
|
||
## Generated tokens | ||
|
||
Use the following request to examine the tokens generated using the analyzer: | ||
|
||
```json | ||
POST /my-lowercase-index/_analyze | ||
{ | ||
"analyzer": "my_lowercase_analyzer", | ||
"text": "This is a Test. OpenSearch 123!" | ||
} | ||
``` | ||
{% include copy-curl.html %} | ||
|
||
The response contains the generated tokens: | ||
|
||
```json | ||
{ | ||
"tokens": [ | ||
{ | ||
"token": "this", | ||
"start_offset": 0, | ||
"end_offset": 4, | ||
"type": "word", | ||
"position": 0 | ||
}, | ||
{ | ||
"token": "is", | ||
"start_offset": 5, | ||
"end_offset": 7, | ||
"type": "word", | ||
"position": 1 | ||
}, | ||
{ | ||
"token": "a", | ||
"start_offset": 8, | ||
"end_offset": 9, | ||
"type": "word", | ||
"position": 2 | ||
}, | ||
{ | ||
"token": "test", | ||
"start_offset": 10, | ||
"end_offset": 14, | ||
"type": "word", | ||
"position": 3 | ||
}, | ||
{ | ||
"token": "opensearch", | ||
"start_offset": 16, | ||
"end_offset": 26, | ||
"type": "word", | ||
"position": 4 | ||
} | ||
] | ||
} | ||
``` |