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.

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

[DOC] add documentation for kuromoji_completion filter #117808

Merged
merged 1 commit into from
Dec 7, 2024
Merged
Changes from all commits
Commits
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
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`.
--