CHANGES.txt

ElasticSearch-Carrot2 Change Log

================ master ====================

================ ElasticSearch-Carrot2 7.17.7 ===================

* ES 7.17.7 compatibility build (manually verified).
* Upgrade to Carrot2 4.3.1.

================ ElasticSearch-Carrot2 7.14.1 ===================

* ES 7.14.1 compatibility build (manually verified).

================ ElasticSearch-Carrot2 7.13.4 ===================

* ES 7.13.4 compatibility build.

================ ElasticSearch-Carrot2 7.12.0 ===================

* ES 7.12.0 compatibility build.

* Upgrade to Carrot2 4.2.1.

================ ElasticSearch-Carrot2 7.11.2 ===================

* ES 7.11.2 API changes and compatibility build.

================ ElasticSearch-Carrot2 7.10.2 ===================

* ES 7.10.2 compatibility build.

================ ElasticSearch-Carrot2 7.10.1 ===================

* ES 7.10.1 compatibility build.

================ ElasticSearch-Carrot2 7.10.0 ===================

* ES 7.10.0 compatibility build.

* Cleanups of build infrastructure.

================ ElasticSearch-Carrot2 7.9.3 ====================

* ES 7.9.3 compatibility build.

================ ElasticSearch-Carrot2 7.9.2 ====================

* ES 7.9.2 compatibility build.

================ ElasticSearch-Carrot2 7.8.1 ====================

* ES 7.8.1 compatibility build.

* Upgrade to Carrot2 4.0.4.

================ ElasticSearch-Carrot2 7.7.1 ====================

Other changes

* Upgrade to Carrot2 4.0.3. Adjust to API changes in language resources.

* API updates to ES 7.7.1. Build scripts updates.

================ ElasticSearch-Carrot2 7.6.0 ====================

Backward-incompatible changes

* Upgrade of Carrot2 to 4.0.0-beta3. This results in a number of backward-incompatible
  changes to the plugin.

  1) The local field for URL (and the corresponding mapping) is gone without replacement.
  2) Names of clustering algorithms have changed. They are now (note white space):
     Lingo, STC, Bisecting K-Means, Lingo3G (optional, commercial)
  3) The language field is no longer a two-letter code. The list of supported languages
     depends on the algorithm and availability of resources and is printed at startup;
     (service extension points are used to load algorithms and languages).
  4) Names and structure of attributes for clustering algorithms have changed. They reflect
     the new, updated Carrot2 API, see:
     https://carrot2.github.io/release/4.0.0-beta3/doc/rest-api-reference/
  5) Algorithm suites and predefined component descriptors (in XML) have been removed and
     are no longer supported. Algorithms are loaded via service extensions.
  6) There are two new request attributes: "language" specifying default clustering
     language for documents that don't declare it explicitly and "create_ungrouped" which
     forces the plugin to create a synthetic group with unclustered document references
     (this corresponds to "other topics" group from previous Carrot2 versions).
  7) Nearly all plugin options have been removed. The single option remaining is "resources"
     with an array of ES configuration folder-relative locations where algorithm resources
     are looked up.
  8) Default lexical resources from Carrot2 are included under configuration folder and
     used by default.

================ ElasticSearch-Carrot2 7.5.0 ====================

Other changes

* Build updates to ES 7.5.0.

================ ElasticSearch-Carrot2 7.3.2 ====================

Other changes

* Build updates to ES 7.3.2.

================ ElasticSearch-Carrot2 7.2.1 ====================

Other changes

* Build updates to ES 7.2.1.
* Switch dependency from simple-xml to simple-xml-safe.

================ ElasticSearch-Carrot2 7.2.0 ====================

Other changes

* Build updates to ES 7.2.0.

================ ElasticSearch-Carrot2 7.1.1 ====================

Other changes

* Build updates to ES 7.1.1.

================ ElasticSearch-Carrot2 7.0.0 ====================

Other changes

* Build updates to ES 7.0.0.

================ ElasticSearch-Carrot2 6.8.5 ====================

Other changes

* Build updates to ES 6.8.5.

================ ElasticSearch-Carrot2 6.7.2 ====================

Other changes

* Build updates to ES 6.7.2.

================ ElasticSearch-Carrot2 6.7.1 ====================

Other changes

* Build updates to ES 6.7.1.

================ ElasticSearch-Carrot2 6.6.2 ====================

Other changes

* Build updates to ES 6.6.2.

================ ElasticSearch-Carrot2 6.5.4 ====================

Other changes

* Build updates to ES 6.5.4.

================ ElasticSearch-Carrot2 6.4.3 ====================

Other changes

* Build updates to ES 6.4.3.

* Permit custom resource lookup location for each algorithm. This can be accomplished
  by declaring a 'esplugin.resources' attribute inside a given component's configuration
  attributes. For example, changing lingo-attributes.xml in the following way:

  <attribute-set id="overridden-attributes">
    <value-set>
      <label>overridden-attributes</label>
      <attribute key="esplugin.resources">
        <value value="lingo-resources"/>
      </attribute>
    </value-set>
  </attribute-set> 

  would cause all algorithm resources to be read from:
  
  {es-home}/config/elasticsearch-carrot2/lingo-resources

================ ElasticSearch-Carrot2 6.3.2 ====================

Other changes

* Build updates to ES 6.3.2. (PR #77, thanks Sergey34).

================ ElasticSearch-Carrot2 6.2.4 ====================

Other changes

* ES security (x-pack) fixes to make it possible to run clustering in secured
  ES instances.

* Upgrade dependency to Carrot2 3.16.0 (and Lingo3G 1.16.0).

* Build updates to ES 6.2.4.

================ ElasticSearch-Carrot2 6.1.1 ====================

* Updates to API changes in ES 6.1.1. (PR #74, thanks Tom Chambers!).

* Updates to API changes in ES 6.0.0.

* REST tests cleanups and updates.

================ ElasticSearch-Carrot2 5.5.2 ====================

Other changes

* Updates to API changes in ES 5.5.2.

================ ElasticSearch-Carrot2 5.4.0 ====================

Other changes

* Updates to API changes in ES 5.4.0.

================ ElasticSearch-Carrot2 5.3.0 ====================

Other changes

* Updates to API changes in ES 5.3.0.

* Documentation fixes (location of resources).

* Added slf4j-log4j12 logging redirector as a default dependency.

* Updated FoamTree and Circles to their newest versions.

* Added logging configuration to silence permission denied exceptions and
  other non-critical information from C2.

================ ElasticSearch-Carrot2 5.2.0 ====================

Other changes

* Updates to API changes in ES 5.2.0.

* GH-60: Upgrade dependency to Carrot2 3.15.1 (and Lingo3G 1.15.1).

================ ElasticSearch-Carrot2 5.1.1 ====================

Other changes

* The first ES version 5.x-compatible release. Moved to Gradle build system from Maven.
  (PR #57, thanks Utkarsh!).

* Java 8 is from now on required.

* Fields will not work unless explicitly stored. Use source filtering instead.
  https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-request-stored-fields.html
  https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-request-source-filtering.html

* Updated documentation links and content.

* Removed the demo _site part of the plugin. ES 5.1.1 onwards there is no 
  support for site plugins.

================ ElasticSearch-Carrot2 2.4.3 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.4.2 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.4.1.1 ==================

* GH-53: Upgrade to C2 3.15.0 and L3G 1.15.0. This is a compatibility
  release. It will work with ES 2.4.1.

================ ElasticSearch-Carrot2 2.4.1 ==================

* GH-50: Upgrade to C2 3.14.0 and L3G 1.14.0.

================ ElasticSearch-Carrot2 2.4.0.1 ==================

* GH-49: Wrong version of morfologik stemming shipped (2.0.1 
  instead of 2.1.0). This is a bugfix release, it will work 
  with ES 2.4.0.

================ ElasticSearch-Carrot2 2.4.0 ====================

* GH-47: Method renamed in ES (compatibility release).

================ ElasticSearch-Carrot2 2.3.4 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.3.2 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.3.0 ====================

Other changes

* ES version/ API compatibility release.

* Visualizations in the docs display proper resolution on high 
  DPI screens.

================ ElasticSearch-Carrot2 2.2.1 ====================

Other changes

* GH-40: Upgrade to C2 3.12.0 and L3G 1.13.0.

* GH-38: Array of fields cannot be used. (Christophe Quintard via Dawid Weiss).

================ ElasticSearch-Carrot2 2.2.0 ====================

Other changes

* GH-37: Added workarounds for tighter security checks in ES 2.2.0.
  The plugin from now on requires custom relaxed policy which has
  to be manually approved during startup.

================ ElasticSearch-Carrot2 2.1.2 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.1.1 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.1.0 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.0.2 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.0.1 ====================

No changes (ES version compatibility release).

================ ElasticSearch-Carrot2 2.0.0 ====================

Other changes

* GH-29: Upgrade to ES 2.0.0 (official).

================ ElasticSearch-Carrot2 2.0.0-rc1 ================

Changes in Backwards Compatibility

* GH-23: Plugin code restructured for ES 2.0.0. Versioning
  scheme will now follow ElasticSearch strictly since starting
  from version 2.0.0 plugins must declare an (exact) version
  of ES they were compiled against.
  
* GH-25: Plugin configuration files have been moved to reside
  inside the plugin. They should be automatically installed
  (copied) to ElasticSearch's config/ folder, where they can
  be tweaked.

Other changes

* GH-28: Add support for es/config and plugin/config relative 
  license locations in Lingo3G

* GH-27: Add dependency on morfologik-stemming.

* GH-24: Update JS visualizations in plugin documentation.

* Dropped support for plugin branches 1.7.x and 1.8.x (ES 1.3.x and
  1.4.x).

================ ElasticSearch-Carrot2 1.9.1 ================

Changes in Backwards Compatibility

* Dependency update to Carrot2 3.10.4 (and Lingo3G 1.12.3).

================ ElasticSearch-Carrot2 1.9.0 ================

Changes in Backwards Compatibility

* Dependency update to ES 1.6.0.

* Dependency update to Carrot2 3.10.1 (and Lingo3G 1.12.0).

* Dependency updates (test libraries).

================ ElasticSearch-Carrot2 1.8.0 ================

Changes in Backwards Compatibility

* Dependency update to ES 1.4.0.

Other changes

* Dropped support branch for ES 1.1.x.

================ ElasticSearch-Carrot2 1.7.0 ================

Changes in Backwards Compatibility

* Dependency update to ES 1.3.0.

================ ElasticSearch-Carrot2 1.6.1 ================

Changes in Backwards Compatibility

* Dependency update to ES 1.2.2.

* Dependency update to Carrot2 3.9.3 (and Lingo3G 1.10.0)

* Demo visualizations updated to their newest version.

================ ElasticSearch-Carrot2 1.6.0 ================

Changes in Backwards Compatibility

* Compatibility update to ES 1.2.0.

================ ElasticSearch-Carrot2 1.5.0 ================

Changes in Backwards Compatibility

* Compatibility upgrade to Carrot2 3.9.2 and Lingo3G 1.9.1.

================ ElasticSearch-Carrot2 1.4.0 ================

Changes in Backwards Compatibility

* Compatibility upgrade to Carrot2 3.9.0 and Lingo3G 1.9.0.

* include_hits parameter is now deprecated in favor of setting 
  max_hits to 0. include_hits = false will act as an alias of
  setting max_hits to 0.

New Features

* GH-9: Add a more flexible limit of the set of returned search results.

================ ElasticSearch-Carrot2 1.3.1 ================

New features

* Added an option to return only cluster labels (omit search hits
  in the response). [thanks @kielni]

================ ElasticSearch-Carrot2 1.3.0 ================

Changes in Backwards Compatibility

* GH-6: Fixes compatibility issues to work with elasticsearch-1.0.0.

================ ElasticSearch-Carrot2 1.2.2 ================

New features

* Added an option to return only cluster labels (omit search hits
  in the response). [thanks @kielni]

================ ElasticSearch-Carrot2 1.2.1 ================

Changes in Backwards Compatibility

* GH-4: Compatibility issue with elasticsearch-0.90.10 (this
  release will not work for ES < 0.90.10).

Bug Fixes

* GH-4: Compatibility issue with elasticsearch-0.90.10

================ ElasticSearch-Carrot2 1.2.0 ================

New Features

* Added an action to return all available clustering algorithms.

* Added support for search-and-cluster requests using HTTP GET (with a subset
  of all the functionality but still useful).

Bug Fixes

* Proper propagation of ProcessingExceptions from Carrot2 framework (in case
  they happen due to, for example, invalid attribute values).

Other

* Added tests for invalid attribute values and proper responses in such
  case (API, REST).

* Refactoring of API classes (nesting classes under ClusteringAction, similar pattern
  will follow for all future *Action implementations).

* Improved tests (test requests are converted to all XContentTypes).

* Restructured the plugin documentation, added table of contents and 
  sections for each REST API method.

* Minor touches for incompatible ES API changes (removed methods in RestActions).

================ ElasticSearch-Carrot2 1.1.1 ================

Other

* Minor touches for incompatible ES API changes (removed methods in RestActions).

================ ElasticSearch-Carrot2 1.1.0 ================

New features

* The size of the clustering controller's component pool is adjustable using
  the configuration file (controller.pool-size option).  

* Added language field mapping descriptors. This helps with multi-lingual 
  clustering -- hints about each document's language can be stored together
  with the document in the index. See the documentation for examples.

Bug Fixes

* GH-1: Front-page example visualizations fail with Lingo3G.

Other

* Update base ES dependency to 0.90.2

* Verified threading (clustering runs on the search thread), added 
  simple stress testing.

* Added information about search threadpool use and potential tweaks to 
  its default size to examples.html

================ ElasticSearch-Carrot2 1.0.1 ================

Bug Fixes

* GH-1: Front-page example visualizations fail with Lingo3G.

================ ElasticSearch-Carrot2 1.0.0 ================

First open source release.