https://github.com/carrotsearch/elasticsearch-lingo3g

elasticsearch-carrot2 plugin extension with Lingo3G support
https://github.com/carrotsearch/elasticsearch-lingo3g

Last synced: 29 days ago
JSON representation

elasticsearch-carrot2 plugin extension with Lingo3G support

• Host: GitHub
• URL: https://github.com/carrotsearch/elasticsearch-lingo3g
• Owner: carrotsearch
• License: apache-2.0
• Created: 2020-10-01T10:29:34.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-19T08:14:10.000Z (almost 2 years ago)
• Last Synced: 2024-03-26T01:08:03.063Z (10 months ago)
• Language: Java
• Size: 149 KB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Lingo3G search results clustering extension for Elasticsearch

=============================================================

This plugin adds on-the-fly text clustering capability

to an Elasticsearch instance.

Note this is an *extension* plugin, it requires 

[elasticsearch-carrot2](https://github.com/carrot2/elasticsearch-carrot2)

plugin to be installed independently and just adds Carrot Search 

Lingo3G algorithm support.

You must own Lingo3G license and have access to its binary

distribution to build and run the plugin. 

Installation

------------

The plugin can be built and installed from sources (preferable)

or by adding Lingo3G JAR to prebuilt plugin binaries and installing

it afterward.

### Installation from sources

To install from sources, install Lingo3G POM in

your local Maven repository first, according to the instructions 

available with Lingo3G distribution.

Elasticsearch will only run plugins that have been built *exactly*

against the given version of its API. Open `build.gradle` and adjust

the version of Lingo3G, Elasticsearch and elasticsearch-carrot2 plugin this

extension will be compiled against:

    localversions = [

        es       : "7.14.1",

        c2plugin : "7.14.1",

        l3g      : "2.0.0",

        log4j    : "2.11.1"

    ]

Then build the plugin:

    ./gradlew clean build

and install in Elasticsearch with (use the full, absolute path):

    Linux:

    bin/elasticsearch-plugin install file:/.../(plugin)/build/distributions/elasticsearch-lingo3g-*.zip

    Windows:

    bin\elasticsearch-plugin install file:///c:/.../(plugin)/build/distributions/elasticsearch-lingo3g-*.zip

The installer will display a popup to request additional permissions for class loader

access and user home folder access. You can comment out (or remove) user home folder access - this

will prevent license scanning there but the plugin will work. Class loader permissions are

required and have to be accepted.

### Installation from binaries

Alternatively, you can also fetch plugin binaries from 

[Maven Central](https://repo1.maven.org/maven2/com/carrotsearch/elasticsearch-lingo3g/).

Once the ZIP distribution of the plugin is downloaded and installed, you will have to add 

Lingo3G JAR to the archive, then proceed with `elasticsearch-plugin` installation above.

Each plugin binary matches the corresponding Elasticsearch version it was compiled against.

We do *not* publish binaries for each and every version of ES so you may have to recompile

from sources from time to time.

Lingo3G license

---------------

The plugin will require a valid license file in one of the following locations:

* `${es-home}/config/`

* `${es-home}/elasticsearch-lingo3g/`

* Elasticsearch user's home folder (if permissions are given)

Compatibility

-------------

| plugin                | elasticsearch         | Lingo3G       |

| ---                   |                   --- | ---           |

| 7.13.4                | 7.13.4                |  2.0.0        |

| 7.12.0                | 7.12.0                |  2.0.0-beta2  |

| 7.11.2                | 7.11.2                |  2.0.0-beta1  |

| 7.10.2                | 7.10.2                |  2.0.0        |

| 7.7.1                 | 7.7.1                 |  2.0.0-beta1  |

Usage

-----

Instructions are identical to that of [elasticsearch-carrot2](https://github.com/carrot2/elasticsearch-carrot2), 

please refer to that plugin's documentation.

License

-------

This plugin is licensed under the Apache 2 license. Full text

of the license is in the repository (`LICENSE.txt`).

Lingo3G is commercial, proprietary software and is not included in 

this bundle. Send an e-mail request to [email protected] for

an evaluation license.