Skip to content

Commit c90bf0d

Browse files
john-wagsterpakio
andauthored
add documentation for kuromoji_completion (#117808) (#118199)
Co-authored-by: Kazuma Arimura <[email protected]>
1 parent c57f1c4 commit c90bf0d

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/plugins/analysis-kuromoji.asciidoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -750,3 +750,39 @@ Which results in:
750750
]
751751
}
752752
--------------------------------------------------
753+
754+
[[analysis-kuromoji-completion]]
755+
==== `kuromoji_completion` token filter
756+
757+
The `kuromoji_completion` token filter adds Japanese romanized tokens to the term attributes along with the original tokens (surface forms).
758+
759+
[source,console]
760+
--------------------------------------------------
761+
GET _analyze
762+
{
763+
"analyzer": "kuromoji_completion",
764+
"text": "寿司" <1>
765+
}
766+
--------------------------------------------------
767+
768+
<1> Returns `寿司`, `susi` (Kunrei-shiki) and `sushi` (Hepburn-shiki).
769+
770+
The `kuromoji_completion` token filter accepts the following settings:
771+
772+
`mode`::
773+
+
774+
--
775+
776+
The tokenization mode determines how the tokenizer handles compound and
777+
unknown words. It can be set to:
778+
779+
`index`::
780+
781+
Simple romanization. Expected to be used when indexing.
782+
783+
`query`::
784+
785+
Input Method aware romanization. Expected to be used when querying.
786+
787+
Defaults to `index`.
788+
--

0 commit comments

Comments
 (0)