honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fix headings for simple analyzer docs (#58910) (#58918)

This commit is contained in:
James Rodewig 2020-07-02 09:52:05 -04:00 committed by GitHub
parent ff04212257
commit 6436792aac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
docs/reference/analysis/analyzers/simple-analyzer.asciidoc
View File

@ -4,25 +4,25 @@
<titleabbrev>Simple</titleabbrev>
++++
The `simple` analyzer breaks text into terms whenever it encounters a
character which is not a letter. All terms are lower cased.
The `simple` analyzer breaks text into tokens at any non-letter character, such
as numbers, spaces, hyphens and apostrophes, discards non-letter characters,
and changes uppercase to lowercase.
[float]
=== Example output
[[analysis-simple-analyzer-ex]]
==== Example
[source,console]
---------------------------
----
POST _analyze
{
"analyzer": "simple",
"text": "The 2 QUICK Brown-Foxes jumped over the lazy dog's bone."
}
---------------------------
/////////////////////
----
////
[source,console-result]
----------------------------
----
{
"tokens": [
{
@ -104,44 +104,40 @@ POST _analyze
}
]
}
----------------------------
----
////
/////////////////////
The above sentence would produce the following terms:
The `simple` analyzer parses the sentence and produces the following
tokens:
[source,text]
---------------------------
----
[ the, quick, brown, foxes, jumped, over, the, lazy, dog, s, bone ]
---------------------------
----
[float]
=== Configuration
[[analysis-simple-analyzer-definition]]
==== Definition
The `simple` analyzer is not configurable.
[float]
=== Definition
The `simple` analzyer consists of:
The `simple` analyzer is defined by one tokenizer:
Tokenizer::
* <<analysis-lowercase-tokenizer,Lower Case Tokenizer>>
* <<analysis-lowercase-tokenizer, Lowercase Tokenizer>>
If you need to customize the `simple` analyzer then you need to recreate
it as a `custom` analyzer and modify it, usually by adding token filters.
This would recreate the built-in `simple` analyzer and you can use it as
a starting point for further customization:
[[analysis-simple-analyzer-customize]]
==== Customize
To customize the `simple` analyzer, duplicate it to create the basis for
a custom analyzer. This custom analyzer can be modified as required, usually by
adding token filters.
[source,console]
----------------------------------------------------
PUT /simple_example
----
PUT /my_index
{
"settings": {
"analysis": {
"analyzer": {
"rebuilt_simple": {
"my_custom_simple_analyzer": {
"tokenizer": "lowercase",
"filter": [ <1>
]
@ -150,6 +146,5 @@ PUT /simple_example
}
}
}
----------------------------------------------------
// TEST[s/\n$/\nstartyaml\n - compare_analyzers: {index: simple_example, first: simple, second: rebuilt_simple}\nendyaml\n/]
<1> You'd add any token filters here.
----
<1> Add token filters here.