forked from opensearch-project/documentation-website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add keep type docs opensearch-project#8063 (opensearch-project#8122)
* adding keep type docs opensearch-project#8063 Signed-off-by: Anton Rubin <[email protected]> * Update keep-types.md Signed-off-by: AntonEliatra <[email protected]> * updating parameter table Signed-off-by: Anton Rubin <[email protected]> * Update keep-types.md Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * fixing types Signed-off-by: Anton Rubin <[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: AntonEliatra <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
- Loading branch information
Showing
2 changed files
with
116 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,115 @@ | ||
| --- | ||
| layout: default | ||
| title: Keep types | ||
| parent: Token filters | ||
| nav_order: 180 | ||
| --- | ||
|
|
||
| # Keep types token filter | ||
|
|
||
| The `keep_types` token filter is a type of token filter used in text analysis to control which token types are kept or discarded. Different tokenizers produce different token types, for example, `<HOST>`, `<NUM>`, or `<ALPHANUM>`. | ||
|
|
||
| The `keyword`, `simple_pattern`, and `simple_pattern_split` tokenizers do not support the `keep_types` token filter because these tokenizers do not support token type attributes. | ||
| {: .note} | ||
|
|
||
| ## Parameters | ||
|
|
||
| The `keep_types` token filter can be configured with the following parameters. | ||
|
|
||
| Parameter | Required/Optional | Data type | Description | ||
| :--- | :--- | :--- | :--- | ||
| `types` | Required | List of strings | List of token types to be kept or discarded (determined by the `mode`). | ||
| `mode`| Optional | String | Whether to `include` or `exclude` the token types specified in `types`. Default is `include`. | ||
|
|
||
|
|
||
| ## Example | ||
|
|
||
| The following example request creates a new index named `test_index` and configures an analyzer with a `keep_types` filter: | ||
|
|
||
| ```json | ||
| PUT /test_index | ||
| { | ||
| "settings": { | ||
| "analysis": { | ||
| "analyzer": { | ||
| "custom_analyzer": { | ||
| "type": "custom", | ||
| "tokenizer": "standard", | ||
| "filter": ["lowercase", "keep_types_filter"] | ||
| } | ||
| }, | ||
| "filter": { | ||
| "keep_types_filter": { | ||
| "type": "keep_types", | ||
| "types": ["<ALPHANUM>"] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| ## Generated tokens | ||
|
|
||
| Use the following request to examine the tokens generated using the analyzer: | ||
|
|
||
| ```json | ||
| GET /test_index/_analyze | ||
| { | ||
| "analyzer": "custom_analyzer", | ||
| "text": "Hello 2 world! This is an example." | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| The response contains the generated tokens: | ||
|
|
||
| ```json | ||
| { | ||
| "tokens": [ | ||
| { | ||
| "token": "hello", | ||
| "start_offset": 0, | ||
| "end_offset": 5, | ||
| "type": "<ALPHANUM>", | ||
| "position": 0 | ||
| }, | ||
| { | ||
| "token": "world", | ||
| "start_offset": 8, | ||
| "end_offset": 13, | ||
| "type": "<ALPHANUM>", | ||
| "position": 2 | ||
| }, | ||
| { | ||
| "token": "this", | ||
| "start_offset": 15, | ||
| "end_offset": 19, | ||
| "type": "<ALPHANUM>", | ||
| "position": 3 | ||
| }, | ||
| { | ||
| "token": "is", | ||
| "start_offset": 20, | ||
| "end_offset": 22, | ||
| "type": "<ALPHANUM>", | ||
| "position": 4 | ||
| }, | ||
| { | ||
| "token": "an", | ||
| "start_offset": 23, | ||
| "end_offset": 25, | ||
| "type": "<ALPHANUM>", | ||
| "position": 5 | ||
| }, | ||
| { | ||
| "token": "example", | ||
| "start_offset": 26, | ||
| "end_offset": 33, | ||
| "type": "<ALPHANUM>", | ||
| "position": 6 | ||
| } | ||
| ] | ||
| } | ||
| ``` |