Skip to content

Commit

Permalink
[DOCS] Reformat reverse token filter docs (#50672)
Browse files Browse the repository at this point in the history
* Updates the description and adds a Lucene link
* Adds analyze and custom analyzer snippets
  • Loading branch information
jrodewig committed Jan 7, 2020
1 parent 1b55688 commit 62ba80f
Showing 1 changed file with 87 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,90 @@
<titleabbrev>Reverse</titleabbrev>
++++

A token filter of type `reverse` that simply reverses each token.
Reverses each token in a stream. For example, you can use the `reverse` filter
to change `cat` to `tac`.

Reversed tokens are useful for suffix-based searches,
such as finding words that end in `-ion` or searching file names by their
extension.

This filter uses Lucene's
https://lucene.apache.org/core/{lucene_version_path}/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html[ReverseStringFilter].

[[analysis-reverse-tokenfilter-analyze-ex]]
==== Example

The following <<indices-analyze,analyze API>> request uses the `reverse`
filter to reverse each token in `quick fox jumps`:

[source,console]
--------------------------------------------------
GET _analyze
{
"tokenizer" : "standard",
"filter" : ["reverse"],
"text" : "quick fox jumps"
}
--------------------------------------------------

The filter produces the following tokens:

[source,text]
--------------------------------------------------
[ kciuq, xof, spmuj ]
--------------------------------------------------

/////////////////////
[source,console-result]
--------------------------------------------------
{
"tokens" : [
{
"token" : "kciuq",
"start_offset" : 0,
"end_offset" : 5,
"type" : "<ALPHANUM>",
"position" : 0
},
{
"token" : "xof",
"start_offset" : 6,
"end_offset" : 9,
"type" : "<ALPHANUM>",
"position" : 1
},
{
"token" : "spmuj",
"start_offset" : 10,
"end_offset" : 15,
"type" : "<ALPHANUM>",
"position" : 2
}
]
}
--------------------------------------------------
/////////////////////

[[analysis-reverse-tokenfilter-analyzer-ex]]
==== Add to an analyzer

The following <<indices-create-index,create index API>> request uses the
`reverse` filter to configure a new
<<analysis-custom-analyzer,custom analyzer>>.

[source,console]
--------------------------------------------------
PUT reverse_example
{
"settings" : {
"analysis" : {
"analyzer" : {
"whitespace_reverse" : {
"tokenizer" : "whitespace",
"filter" : ["reverse"]
}
}
}
}
}
--------------------------------------------------

0 comments on commit 62ba80f

Please sign in to comment.