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 keyword marker token filter docs opensearch-project#8065 (opensea…
…rch-project#8134) * Add keyword marker token filter docs opensearch-project#8065 Signed-off-by: Anton Rubin <[email protected]> * Update keyword-marker.md Signed-off-by: AntonEliatra <[email protected]> * updating parameter table Signed-off-by: Anton Rubin <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * Change example Signed-off-by: Fanit Kolchina <[email protected]> * Add article to elision token filter 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: AntonEliatra <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
- Loading branch information
4 people
authored
Nov 14, 2024
1 parent
883b673
commit 37bbf24
Showing
3 changed files
with
129 additions
and
2 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
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,127 @@ | ||
| --- | ||
| layout: default | ||
| title: Keyword marker | ||
| parent: Token filters | ||
| nav_order: 200 | ||
| --- | ||
|
|
||
| # Keyword marker token filter | ||
|
|
||
| The `keyword_marker` token filter is used to prevent certain tokens from being altered by stemmers or other filters. The `keyword_marker` token filter does this by marking the specified tokens as `keywords`, which prevents any stemming or other processing. This ensures that specific words remain in their original form. | ||
|
|
||
| ## Parameters | ||
|
|
||
| The `keyword_marker` token filter can be configured with the following parameters. | ||
|
|
||
| Parameter | Required/Optional | Data type | Description | ||
| :--- | :--- | :--- | :--- | ||
| `ignore_case` | Optional | Boolean | Whether to ignore the letter case when matching keywords. Default is `false`. | ||
| `keywords` | Required if either `keywords_path` or `keywords_pattern` is not set | List of strings | The list of tokens to mark as keywords. | ||
| `keywords_path` | Required if either `keywords` or `keywords_pattern` is not set | String | The path (relative to the `config` directory or absolute) to the list of keywords. | ||
| `keywords_pattern` | Required if either `keywords` or `keywords_path` is not set | String | A [regular expression](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html) used for matching tokens to be marked as keywords. | ||
|
|
||
|
|
||
| ## Example | ||
|
|
||
| The following example request creates a new index named `my_index` and configures an analyzer with a `keyword_marker` filter. The filter marks the word `example` as a keyword: | ||
|
|
||
| ```json | ||
| PUT /my_index | ||
| { | ||
| "settings": { | ||
| "analysis": { | ||
| "analyzer": { | ||
| "custom_analyzer": { | ||
| "type": "custom", | ||
| "tokenizer": "standard", | ||
| "filter": ["lowercase", "keyword_marker_filter", "stemmer"] | ||
| } | ||
| }, | ||
| "filter": { | ||
| "keyword_marker_filter": { | ||
| "type": "keyword_marker", | ||
| "keywords": ["example"] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| ## Generated tokens | ||
|
|
||
| Use the following request to examine the tokens generated using the analyzer: | ||
|
|
||
| ```json | ||
| GET /my_index/_analyze | ||
| { | ||
| "analyzer": "custom_analyzer", | ||
| "text": "Favorite example" | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| The response contains the generated tokens. Note that while the word `favorite` was stemmed, the word `example` was not stemmed because it was marked as a keyword: | ||
|
|
||
| ```json | ||
| { | ||
| "tokens": [ | ||
| { | ||
| "token": "favorit", | ||
| "start_offset": 0, | ||
| "end_offset": 8, | ||
| "type": "<ALPHANUM>", | ||
| "position": 0 | ||
| }, | ||
| { | ||
| "token": "example", | ||
| "start_offset": 9, | ||
| "end_offset": 16, | ||
| "type": "<ALPHANUM>", | ||
| "position": 1 | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| You can further examine the impact of the `keyword_marker` token filter by adding the following parameters to the `_analyze` query: | ||
|
|
||
| ```json | ||
| GET /my_index/_analyze | ||
| { | ||
| "analyzer": "custom_analyzer", | ||
| "text": "This is an OpenSearch example demonstrating keyword marker.", | ||
| "explain": true, | ||
| "attributes": "keyword" | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| This will produce additional details in the response similar to the following: | ||
|
|
||
| ```json | ||
| { | ||
| "name": "porter_stem", | ||
| "tokens": [ | ||
| ... | ||
| { | ||
| "token": "example", | ||
| "start_offset": 22, | ||
| "end_offset": 29, | ||
| "type": "<ALPHANUM>", | ||
| "position": 4, | ||
| "keyword": true | ||
| }, | ||
| { | ||
| "token": "demonstr", | ||
| "start_offset": 30, | ||
| "end_offset": 43, | ||
| "type": "<ALPHANUM>", | ||
| "position": 5, | ||
| "keyword": false | ||
| }, | ||
| ... | ||
| ] | ||
| } | ||
| ``` |