honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/plugins/analysis-smartcn.asciidoc

50 lines
1.5 KiB
Plaintext
Raw Normal View History

Docs: Prepare plugin and integration docs for 2.0 * Centralised plugin docs in docs/plugins/ * Moved integrations into same docs * Moved community clients into the clients section of the docs * Removed docs/community Closes #11734 Closes #11724 Closes #11636 Closes #11635 Closes #11632 Closes #11630 Closes #12046 Closes #12438 Closes #12579
2015-08-15 12:00:55 -04:00
[[analysis-smartcn]]
=== Smart Chinese Analysis Plugin
The Smart Chinese Analysis plugin integrates Lucene's Smart Chinese analysis
module into elasticsearch.
It provides an analyzer for Chinese or mixed Chinese-English text. This
analyzer uses probabilistic knowledge to find the optimal word segmentation
for Simplified Chinese text. The text is first broken into sentences, then
each sentence is segmented into words.
[[analysis-smartcn-install]]
[float]
==== Installation
This plugin can be installed using the plugin manager:
[source,sh]
----------------------------------------------------------------
Rename bin/plugin in bin/elasticsearch-plugin
2016-02-04 10:00:55 -05:00
sudo bin/elasticsearch-plugin install analysis-smartcn
Docs: Prepare plugin and integration docs for 2.0 * Centralised plugin docs in docs/plugins/ * Moved integrations into same docs * Moved community clients into the clients section of the docs * Removed docs/community Closes #11734 Closes #11724 Closes #11636 Closes #11635 Closes #11632 Closes #11630 Closes #12046 Closes #12438 Closes #12579
2015-08-15 12:00:55 -04:00
----------------------------------------------------------------
Add `// NOTCONSOLE` to docs We have 1074 snippets that look like they should be converted to `// CONSOLE`. At least that is what `gradle docs:listConsoleCandidates` says. This adds `// NOTCONSOLE` to explicitly mark snippets that *shouldn't* be converted to `// CONSOLE`. After marking the blindingly obvious ones this cuts the remaining snippet count to 1032.
2016-08-10 18:00:58 -04:00
// NOTCONSOLE
Docs: Prepare plugin and integration docs for 2.0 * Centralised plugin docs in docs/plugins/ * Moved integrations into same docs * Moved community clients into the clients section of the docs * Removed docs/community Closes #11734 Closes #11724 Closes #11636 Closes #11635 Closes #11632 Closes #11630 Closes #12046 Closes #12438 Closes #12579
2015-08-15 12:00:55 -04:00
The plugin must be installed on every node in the cluster, and each node must
be restarted after installation.
[[analysis-smartcn-remove]]
[float]
==== Removal
The plugin can be removed with the following command:
[source,sh]
----------------------------------------------------------------
Rename bin/plugin in bin/elasticsearch-plugin
2016-02-04 10:00:55 -05:00
sudo bin/elasticsearch-plugin remove analysis-smartcn
Docs: Prepare plugin and integration docs for 2.0 * Centralised plugin docs in docs/plugins/ * Moved integrations into same docs * Moved community clients into the clients section of the docs * Removed docs/community Closes #11734 Closes #11724 Closes #11636 Closes #11635 Closes #11632 Closes #11630 Closes #12046 Closes #12438 Closes #12579
2015-08-15 12:00:55 -04:00
----------------------------------------------------------------
Add `// NOTCONSOLE` to docs We have 1074 snippets that look like they should be converted to `// CONSOLE`. At least that is what `gradle docs:listConsoleCandidates` says. This adds `// NOTCONSOLE` to explicitly mark snippets that *shouldn't* be converted to `// CONSOLE`. After marking the blindingly obvious ones this cuts the remaining snippet count to 1032.
2016-08-10 18:00:58 -04:00
// NOTCONSOLE
Docs: Prepare plugin and integration docs for 2.0 * Centralised plugin docs in docs/plugins/ * Moved integrations into same docs * Moved community clients into the clients section of the docs * Removed docs/community Closes #11734 Closes #11724 Closes #11636 Closes #11635 Closes #11632 Closes #11630 Closes #12046 Closes #12438 Closes #12579
2015-08-15 12:00:55 -04:00
The node must be stopped before removing the plugin.
[[analysis-smartcn-tokenizer]]
[float]
==== `smartcn` tokenizer and token filter
The plugin provides the `smartcn` analyzer and `smartcn_tokenizer` tokenizer,
which are not configurable.
NOTE: The `smartcn_word` token filter and `smartcn_sentence` have been deprecated.