Skip to content
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.

Sign up for GitHub

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

[DOCS] Fix headings for simple analyzer docs #58910

Merged
merged 1 commit into from
Jul 2, 2020
Merged

[DOCS] Fix headings for simple analyzer docs #58910

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 23 additions & 29 deletions docs/reference/analysis/analyzers/simple-analyzer.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@
<titleabbrev>Simple</titleabbrev>
++++

The `simple` analyzer breaks text into terms at any non-letter character, such
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.

[[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": [
{
Expand Down Expand Up @@ -104,53 +104,47 @@ POST _analyze
}
]
}
----------------------------

/////////////////////

----
////

The `simple` analyzer parses the sentence and produces the following
terms:
tokens:

[source,text]
---------------------------
----
[ the, quick, brown, foxes, jumped, over, the, lazy, dog, s, bone ]
---------------------------

==== Configure parameters

The `simple` analyzer does not contain configurable parameters.
----

==== Customize
[[analysis-simple-analyzer-definition]]
==== Definition

The `simple` analyzer is defined by one tokenizer:

Tokenizer::
* <<analysis-lowercase-tokenizer,Lower Case Tokenizer>>
* <<analysis-lowercase-tokenizer, Lowercase Tokenizer>>

[[analysis-simple-analyzer-customize]]
==== Customize

To customize the `simple` analyzer, duplicate it to create the basis for
a `custom` analyzer. The new analyzer can be modified as required, usually by
a custom analyzer. This custom analyzer can be modified as required, usually by
adding token filters.

===== Example

[source,console]
----------------------------------------------------
PUT /simple_example
----
PUT /my_index
{
"settings": {
"analysis": {
"analyzer": {
"rebuilt_simple": {
"my_custom_simple_analyzer": {
"tokenizer": "lowercase",
"filter": [ <1>
"filter": [ <1>
]
}
}
}
}
}
----------------------------------------------------
// TEST[s/\n$/\nstartyaml\n - compare_analyzers: {index: simple_example, first: simple, second: rebuilt_simple}\nendyaml\n/]

----
<1> Add token filters here.