-
Notifications
You must be signed in to change notification settings - Fork 500
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding standard analyzer docs #8528
Merged
kolchfa-aws
merged 7 commits into
opensearch-project:main
from
AntonEliatra:adding-standard-analyzer-docs
Dec 10, 2024
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0d694e1
adding standard analyzer docs
AntonEliatra 3d878a2
Merge branch 'opensearch-project:main' into adding-standard-analyzer-…
AntonEliatra a3daaa0
adding further details
AntonEliatra 336f848
adding more examples
AntonEliatra 6c13948
Doc review
kolchfa-aws 9fd184d
Apply suggestions from code review
kolchfa-aws 89c935c
Merge branch 'main' into adding-standard-analyzer-docs
kolchfa-aws File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,96 @@ | ||||||
--- | ||||||
layout: default | ||||||
title: Standard analyzer | ||||||
nav_order: 40 | ||||||
--- | ||||||
|
||||||
# Standard analyzer | ||||||
|
||||||
The `standard` analyzer is the default analyzer used when no other analyzer is specified. It is designed to provide a basic and efficient approach to generic text processing. | ||||||
|
||||||
This analyzer consists of the following tokenizers and token filters: | ||||||
|
||||||
- `standard` tokenizer: Removes most punctuation and splits text on spaces and other common delimiters. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will consistently use "on". |
||||||
- `lowercase` token filter: Converts all tokens to lowercase, ensuring case-insensitive matching. | ||||||
- `stop` token filter: Removes common stopwords, such as "the", "is", and "and", from the tokenized output. | ||||||
|
||||||
## Example | ||||||
|
||||||
Use the following command to create an index named `my_standard_index` with a `standard` analyzer: | ||||||
|
||||||
```json | ||||||
PUT /my_standard_index | ||||||
{ | ||||||
"mappings": { | ||||||
"properties": { | ||||||
"my_field": { | ||||||
"type": "text", | ||||||
"analyzer": "standard" | ||||||
} | ||||||
} | ||||||
} | ||||||
} | ||||||
``` | ||||||
{% include copy-curl.html %} | ||||||
|
||||||
## Parameters | ||||||
|
||||||
You can configure a `standard` analyzer with the following parameters. | ||||||
|
||||||
Parameter | Required/Optional | Data type | Description | ||||||
:--- | :--- | :--- | :--- | ||||||
`max_token_length` | Optional | Integer | Sets the maximum length of the produced token. If this length is exceeded, the token is split into multiple tokens at the length configured in `max_token_length`. Default is `255`. | ||||||
`stopwords` | Optional | String or list of strings | A string specifying a predefined list of stopwords (such as `_english_`) or an array specifying a custom list of stopwords. Default is `_none_`. | ||||||
`stopwords_path` | Optional | String | The path (absolute or relative to the config directory) to the file containing a list of stop words. | ||||||
|
||||||
|
||||||
## Configuring a custom analyzer | ||||||
|
||||||
Use the following command to configure an index with a custom analyzer that is equivalent to the `standard` analyzer: | ||||||
|
||||||
```json | ||||||
PUT /my_custom_index | ||||||
{ | ||||||
"settings": { | ||||||
"analysis": { | ||||||
"analyzer": { | ||||||
"my_custom_analyzer": { | ||||||
"type": "custom", | ||||||
"tokenizer": "standard", | ||||||
"filter": [ | ||||||
"lowercase", | ||||||
"stop" | ||||||
] | ||||||
} | ||||||
} | ||||||
} | ||||||
} | ||||||
} | ||||||
``` | ||||||
{% include copy-curl.html %} | ||||||
|
||||||
## Generated tokens | ||||||
|
||||||
Use the following request to examine the tokens generated using the analyzer: | ||||||
|
||||||
```json | ||||||
POST /my_custom_index/_analyze | ||||||
{ | ||||||
"analyzer": "my_custom_analyzer", | ||||||
"text": "The slow turtle swims away" | ||||||
} | ||||||
``` | ||||||
{% include copy-curl.html %} | ||||||
|
||||||
The response contains the generated tokens: | ||||||
|
||||||
```json | ||||||
{ | ||||||
"tokens": [ | ||||||
{"token": "slow","start_offset": 4,"end_offset": 8,"type": "<ALPHANUM>","position": 1}, | ||||||
{"token": "turtle","start_offset": 9,"end_offset": 15,"type": "<ALPHANUM>","position": 2}, | ||||||
{"token": "swims","start_offset": 16,"end_offset": 21,"type": "<ALPHANUM>","position": 3}, | ||||||
{"token": "away","start_offset": 22,"end_offset": 26,"type": "<ALPHANUM>","position": 4} | ||||||
] | ||||||
} | ||||||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 13: I believe we had been using "split text at" (as opposed to "on"), but "on" started appearing in recent docs. Please ensure global consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will address this as a separate PR globally.