Skip to content

Commit

Permalink
add documentation for kuromoji_completion (#117808)
Browse files Browse the repository at this point in the history
  • Loading branch information
pakio authored and john-wagster committed Dec 7, 2024
1 parent af14de5 commit 2496d51
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/plugins/analysis-kuromoji.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -750,3 +750,39 @@ Which results in:
]
}
--------------------------------------------------

[[analysis-kuromoji-completion]]
==== `kuromoji_completion` token filter

The `kuromoji_completion` token filter adds Japanese romanized tokens to the term attributes along with the original tokens (surface forms).

[source,console]
--------------------------------------------------
GET _analyze
{
"analyzer": "kuromoji_completion",
"text": "寿司" <1>
}
--------------------------------------------------

<1> Returns `寿司`, `susi` (Kunrei-shiki) and `sushi` (Hepburn-shiki).

The `kuromoji_completion` token filter accepts the following settings:

`mode`::
+
--

The tokenization mode determines how the tokenizer handles compound and
unknown words. It can be set to:

`index`::

Simple romanization. Expected to be used when indexing.

`query`::

Input Method aware romanization. Expected to be used when querying.

Defaults to `index`.
--

0 comments on commit 2496d51

Please sign in to comment.