This clustering plugin adds on-the-fly text clustering capability to an ElasticSearch node. Clustering algorithms from the Carrot2 project (open source) or proprietary Lingo3G algorithm from Carrot Search can be used for actual clustering implementation.
In order to install a stable version of the plugin,
run ElasticSearch's plugin
utility (remember to pick the
compatible version of the plugin from the table below).
bin/plugin --install org.carrot2/elasticsearch-carrot2/1.8.0
To install from sources (master branch), run:
mvn clean package
and unzip target/releases/*.zip
into ES's plugins subfolder of
your choice.
Once installed, restart ElasticSearch and point your browser to: http://localhost:9200/_plugin/carrot2/ (or wherever your ES node is deployed). That file contains some sample data and query examples.
Alternatively, the plugin's folder contains _site/curl/
sub-folder
which in turn contains sample curl
scripts that inject data into
ES and query the clustering plugin.
Recommended compatiblity chart (matching versions of ES, Carrot2, and optionally Lingo3G). (+) means it'll probably work with newer releases (we test against latest version from that branch). master? means it should (but may not) work against head-of-development too.
------------------------------------------------------------------
| Clustering Plugin | Elasticsearch | Carrot2 | Lingo3G |
------------------------------------------------------------------
| master | 1.4.0 -> 1.5.2+? | 3.9.3 | 1.10.0 |
| 1.8.0 | 1.4.0 -> 1.5.2+ | 3.9.3 | 1.10.0 |
| 1.7.0 | 1.3.0 -> 1.3.5+ | 3.9.3 | 1.10.0 |
| 1.6.0 | 1.2.0 -> 1.2.2+ | 3.9.2 | 1.9.1 |
------------------------------------------------------------------
Discontinued version branches:
------------------------------------------------------------------
| Clustering Plugin | Elasticsearch | Carrot2 | Lingo3G |
------------------------------------------------------------------
| 1.5.0 | 1.1.0 -> 1.1.2+ | 3.9.2 | 1.9.1 |
| 1.4.0 | 1.0.0 -> 1.0.3 | 3.9.0 | 1.9.0 |
| 1.3.1 | 1.0.0 -> 1.0.3 | 3.8.1 | 1.8.1 |
| 1.3.0 | 1.0.0 -> 1.0.3 | 3.8.1 | 1.8.1 |
| 1.2.2 | 0.90.10-> 0.90.13 | 3.8.0 | 1.8.0 |
| 1.2.1 | 0.90.10-> 0.90.11 | 3.8.0 | 1.8.0 |
| 1.2.0 | 0.90.4 -> 0.90.9 | 3.8.0 | 1.8.0 |
| 1.1.1 | 0.90.4 -> 0.90.9 | 3.8.0 | 1.8.0 |
| 1.1.0 | 0.90.2 -> 0.90.3 | 3.8.0 | 1.8.0 |
| 1.0.1 | 0.90 -> 0.90.3 | 3.7.1 | 1.7.1 |
| 1.0.0 | 0.90 -> 0.90.3 | 3.7.1 | 1.7.1 |
------------------------------------------------------------------
This software is licensed under the Apache 2 license. Full text
of the license is in the repository (LICENSE.txt
).