honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 10:25:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add response snippets to 'Testing analyzers' page (#51427)

Browse Source 
Adds response snippets to the `POST _analyze` snippets in the 'Testing
analyzers' page.

Co-authored-by: Emmanuel DEMEY <demey.emmanuel@gmail.com>
This commit is contained in:
James Rodewig 2020-01-27 08:41:05 -05:00
parent 716904fab7
commit 23b65390ab
1 changed files with 122 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
docs/reference/analysis/testing.asciidoc
View File

@ -2,8 +2,7 @@
=== Test an analyzer
The <<indices-analyze,`analyze` API>> is an invaluable tool for viewing the
terms produced by an analyzer. A built-in analyzer (or combination of built-in
tokenizer, token filters, and character filters) can be specified inline in
terms produced by an analyzer. A built-in analyzer can be specified inline in
the request:
[source,console]
@ -13,7 +12,54 @@ POST _analyze
"analyzer": "whitespace",
"text": "The quick brown fox."
}
-------------------------------------
The API returns the following response:
[source,console-result]
-------------------------------------
{
"tokens": [
{
"token": "The",
"start_offset": 0,
"end_offset": 3,
"type": "word",
"position": 0
},
{
"token": "quick",
"start_offset": 4,
"end_offset": 9,
"type": "word",
"position": 1
},
{
"token": "brown",
"start_offset": 10,
"end_offset": 15,
"type": "word",
"position": 2
},
{
"token": "fox.",
"start_offset": 16,
"end_offset": 20,
"type": "word",
"position": 3
}
]
}
-------------------------------------
You can also test combinations of:
* A tokenizer
* Zero or token filters
* Zero or more character filters
[source,console]
-------------------------------------
POST _analyze
{
"tokenizer": "standard",
@ -22,7 +68,43 @@ POST _analyze
}
-------------------------------------
The API returns the following response:
[source,console-result]
-------------------------------------
{
"tokens": [
{
"token": "is",
"start_offset": 0,
"end_offset": 2,
"type": "<ALPHANUM>",
"position": 0
},
{
"token": "this",
"start_offset": 3,
"end_offset": 7,
"type": "<ALPHANUM>",
"position": 1
},
{
"token": "deja",
"start_offset": 8,
"end_offset": 12,
"type": "<ALPHANUM>",
"position": 2
},
{
"token": "vu",
"start_offset": 13,
"end_offset": 15,
"type": "<ALPHANUM>",
"position": 3
}
]
}
-------------------------------------
.Positions and character offsets
*********************************************************
@ -80,6 +162,44 @@ GET my_index/_analyze <3>
}
-------------------------------------
The API returns the following response:
[source,console-result]
-------------------------------------
{
"tokens": [
{
"token": "is",
"start_offset": 0,
"end_offset": 2,
"type": "<ALPHANUM>",
"position": 0
},
{
"token": "this",
"start_offset": 3,
"end_offset": 7,
"type": "<ALPHANUM>",
"position": 1
},
{
"token": "deja",
"start_offset": 8,
"end_offset": 12,
"type": "<ALPHANUM>",
"position": 2
},
{
"token": "vu",
"start_offset": 13,
"end_offset": 15,
"type": "<ALPHANUM>",
"position": 3
}
]
}
-------------------------------------
<1> Define a `custom` analyzer called `std_folded`.
<2> The field `my_text` uses the `std_folded` analyzer.
<3> To refer to this analyzer, the `analyze` API must specify the index name.