Home / Releases

Releases

View on Github

zentity-1.8.2 (latest)

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Minor - The Setup API now creates the .zentity-models index with the setting index.hidden: true. This will not change the behavior of new or old .zentity-models indices. Hidden indices are protected against accidental removal by wildcard index deletions. (f4b7127)
Other - Compatibility with Elasticsearch versions prior to 7.14.1 will no longer be maintained due to changes in the Elasticsearch Java API. (d9354aa)

zentity-1.8.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug Fix - Fixed bug where resolution jobs failed to obtain attribute values from object arrays. (Issue: #85, PR: #86)

zentity-1.8.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Added the Bulk Models API, which efficiently runs multiple entity model management operations in series. (Issue: #57, PR: #82)
Feature - Added the Bulk Resolution API, which efficiently runs multiple entity resolution jobs in parallel. (Issue: #50, PR: #79, #84)

zentity-1.7.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Allow attributes to be represented as nested fields in the "_attributes" section of the resolution response. (Issue: #77)
Breaking change - Enforce naming requirements for entity types, attributes, resolvers, and matchers. (Issue: #58, #73) (PR: #63, #75)
Security - Updated Jackson dependency to resolve security vulnerability CVE-2020-25649. (9fc145b)
Minor - Allow more lenient validation of empty objects in Models API. (Issue: #72) (PR: #74)
Minor - Allow integers to be given as inputs to float fields. (Issue: #59)

zentity-1.6.2

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug fix - Fixed an issue that affected the stability of clusters with multiple nodes using Elasticsearch versions >= 7.9.0. (Issue #56)

zentity-1.6.1

Download

Select the plugin version that matches your version of Elasticsearch:

Note: There is an issue in zentity 1.6.1 that affects the stability of clusters with multiple nodes using Elasticsearch versions >= 7.9.0. It is strongly recommended to upgrade zentity.

Release notes

Security - Updated Jackson dependency to resolve security vulnerability CVE-2020-14062. (44b908c)
Other - Compatibility with Elasticsearch versions prior to 7.7.0 will no longer be maintained due to changes in the Elasticsearch Java API. (44b908c)

zentity-1.6.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - This release introduces identity confidence scoring to the Resolution API. Added the attribute identity confidence base score, matcher quality score, and index field quality score to the Entity Model Specification. Added the "_score" field to the Entity Resolution Output Specification. Added an optional _score parameter to the Resolution API. (PR 39)

zentity-1.5.2

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Added new URL parameters to the Resolution API: max_time_per_query, _seq_no_primary_term, _version, and several parameters for advanced search optimizations. (14bbe8a)
Security - Updated Jackson dependency to resolve security vulnerabilities CVE-2019-14540, CVE-2019-16335, CVE-2019-16942, CVE-2019-16943, CVE-2019-17531, CVE-2019-20330, CVE-2020-8840. (3d325e2)
Other - Compatibility with Elasticsearch versions prior to 7.4.0 will no longer be maintained due to changes in the Elasticsearch Java API. (84d101b)

zentity-1.5.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug fix - Ensure that null values and missing fields are not passed to the "_attributes" object. This bug only affected the output of "_attributes" and not the accuracy of the resolution job. (c03ce76)

zentity-1.5.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Breaking change - Attribute values in the "_attributes" object of each document returned by the Resolution API are now arrays of values instead of single values. (c2c723b)
Bug fix - Fixed cases in which null values or missing fields from the "_source" field caused jobs to fail with a validation exception. Null values and missing fields are now skipped. (998c04b)

zentity-1.4.2

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug fix - Fixed a bug in the logic that determines whether an index in the entity model should be queried at a given hop in the resolution job. There were cases observed in which zentity queried an index even though it had not gathered sufficent attribute values to populate any resolvers. In those cases, zentity submitted an empty query to Elasticsearch, which caused the resolution job to fail because an empty query is an invalid syntax. (431e2d8)
Bug fix - During a resolution job, when Elasticsearch retrieves a document that lacks an index field defined in the entity model, zentity now skips that field and attempt to extract the other fields. Previously, jobs failed whenever an index field defined in the entity model was missing from any retrieved documents. But it's entirely valid for documents in Elasticsearch to lack fields that are defined in the index mapping. (cbaaa51)
Bug fix - The HTTP response code for a failed resolution job is now 500 instead of 200. (f4e629c)
Feature - zentity now handles any exception thrown during a resolution job. zentity allows a Java stack trace and all hits and queries up to the point of failure to be included in the response when a resolution job fails. (f4e629c)

zentity-1.4.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Catch errors returned by Elasticsearch and then fail the job. Include the error and the query context in the response. Allow errors where the index was not found, and ignore those indices in subsequent hops. (3e96b6d)
Security - Updated Jackson dependency to resolve security vulnerabilities CVE-2019-14379, CVE-2019-14439. (189e412)
Other - Now using JDK 11 instead of JDK 8 to build zentity. (94c4f90)

zentity-1.4.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Added an optional "terms" field to the resolution input which allows resolutions jobs to be submitted with unknown or unstructured input values. (1f3e452)
Feature - Added a "_query" field to each object under "hit"."hits" and "queries" to indicate which query of which hop that the object relates to. (ac567bb)
Breaking change - Renamed "queries"."resolvers" to "queries"."filters" and changed its structure. (1f3e452)

zentity-1.3.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug fix - When checking the existence of a resolver with a higher weight, the absence of any attribute should imply that the resolver does not exist. Until now the boolean logic had checked for the absence of all attributes of the resolver. This has been corrected to check for the absence of any attribute of the resolver. (4d97d39)
Bug fix - When submitting a resolution request with an embedded model and an entity type, raise an error because the request is ambiguous. (b45b24a)
Bug fix - When submitting a resolution request with an embedded model and no entity type, process the request. (b45b24a)
Bug fix - Return an error when an unrecognized field exists in the resolution request. (3fdde88)
Security - Updated Jackson dependency to resolve security vulnerability CVE-2019-12814. (a8e006e)
Minor - Removed redundant "bool" wrapper clauses. (a1332ce)

zentity-1.3.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Breaking change - Renamed "priorty" to "weight" in the resolver objects. (117f38f)

zentity-1.2.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Added an optional "_explanation" field to each document in the response object of the Resolution API. This field explains which resolvers caused a document to match, and more specifically, which input value matched which indexed value using which matcher and params. (08a2ffc)

zentity-1.1.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Introduced the concept of resolver priority. (a57958d)
Breaking change - Changed the structure of "queries"."resolvers"."tree" in the response object of the Resolution API). (0d76da0)

zentity-1.0.3

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug fix - Fixed bug where model attribute params did not override matcher params. (3e0728b)
Security - Updated Jackson dependency to resolve security vulnerabilities CVE-2018-12022, CVE-2018-19360, CVE-2018-19361, CVE-2018-19362, CVE-2018-14721, CVE-2018-14718, CVE-2018-14719, CVE-2018-14720. (1ad9127)

zentity-1.0.2

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Security - Updated Jackson dependency to resolve security vulnerability CVE-2018-7489. (214eee1)

zentity-1.0.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Plugin now supports Elasticsearch 6.5.x, and compatibility with older versions of Elasticsearch will no longer be maintained. Updated painless script for formatting dates. (56b94b7)

zentity-1.0.0

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Added the "ids" field in the request payload of the Resolution API. This allows a job to be started by selecting document(s) by _id(s) known to be associated with an entity. Either or both of the "ids" and "attributes" fields must be present and valid to start a job. (b2f48bc)
Feature - Added the POST _zentity/_setup endpoint to create the .zentity-models index. This allows an administrator to set up the index in advance without having to give users permission to create or manage the index when using X-Pack Security. And it allows the number of shards and replicas to be defined as URI parameters. (79a00e3)
Bug fix - Fixed a NullPointerException whenever an entity_type does not exist when submitting a resolution job. (b5b6d88)

zentity-0.5.0-beta.2

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug fix - Removed a log statement that was printing the contents of each query and slowing down resolution jobs. (b421fc5)

zentity-0.5.0-beta.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Arbitrary params can be passed to the matchers clauses as variables, using the syntax {{ params.<param_value> }} (example: {{ params.fuzziness }}). Default params can be specified in "matchers".MATCHER_NAME."params" and overridden in "attributes".ATTRIBUTE_NAME."params" in either the model or the input. (b2bdb09)
Feature - Added the "date" attribute type which requires a "format" param to be specified. Date values are queried and returned in the specified format. (325b98c)
Breaking change - Input attribute values must always be specified in arrays. For example, { "attributes": { "id": "123" }} would need to be changed to { "attributes": { "id": [ "123" ] }}. (b2bdb09)
Breaking change - Deprecated the "matchers".MATCHER_NAME."type" field. Matcher types will not be necessary given the ability to pass arbitrary params into the matcher clauses. Any existing models with this field will need to be updated to have this field removed. (b2bdb09)
Breaking change - Deprecated the "entity_id" field of the request payload for the Resolution API. If an entity_id is to be specified, it must always be done in the path of the Resolution API endpoint (_zentity/resolution/<entity_type>). Any clients that are specifying the entity_id in the request payload will need to be changed to use this endpoint instead. (b2bdb09)

zentity-0.4.0-beta.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Resolution jobs now support exclusive and inclusive scoping (i.e. blacklisting and whitelisting) based on attributes, resolvers, and indices. Exclusive scoping takes precedence over inclusive scoping. (28fcea5) New parameters include:
- scope.exclude.attributes
- scope.exclude.indices
- scope.exclude.resolvers
- scope.include.attributes
- scope.include.indices
- scope.include.resolvers
Breaking change - The scope.indices and scope.resolvers parameters of the Resolution API have been replaced with scope.exclude and scope.include. (28fcea5)

zentity-0.3.0-beta.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Queries with multiple resolvers now nest the clauses for each attribute as a tree instead of a flat list of lists, eliminating redundant clauses. For example, a query with two resolvers [ "name", "email" ] and [ "name", "phone" ] will nest the "email" and "phone" clauses under the "name" clause instead of duplicating the "name" clause. (f425f4f)
Feature - The queries parameter of the Resolution API now include "_hop", "_index", and "resolvers" for each query. The "resolvers" field lists the names of the resolvers used in the query ("resolvers.list") and the nested structure of the attribute clauses ("resolvers.tree"). (f425f4f)
Breaking change - The queries parameter of the Resolution API has moved the "request" and "response" fields of each query under a field called "search". (f425f4f)

zentity-0.2.1-beta.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Index fields with nested properties of arbitrary depth (e.g. "person.name.first.keyword") are now supported. (75d4fb8)
Bug fix - Fixed two NullPointerExceptions by skipping cases where the attribute or matcher of an index field do not exist in the entity model. (75d4fb8)

zentity-0.2.0-beta.1

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Feature - Overhauled the entity model specification to allow new features to be added to it without causing breaking changes. Decoupled "attributes" and "matchers". The "indices" object now maps index "fields" to an "attribute" and a "matcher". (5b28a26)
Feature - Introduced the concept of attribute types. Added the "string", "number", and "boolean" attribute types. (19f7047)
Feature - Introduced the concept of matcher types. Added the "value" matcher type. (19f7047)
Bug fix - Returning the values of attributes in the "_attributes" field as they existed in the "_source" field instead of trying to manually convert their data types. (19f7047)
Breaking change - Entity models must be recreated to conform to the new entity model specification. (5b28a26)

zentity-0.1.1-beta.2

Download

Select the plugin version that matches your version of Elasticsearch:

Release notes

Bug fix - Renamed max_docs_per_hop to max_docs_per_query in the Resolution API. (6cde2ef)
Breaking change - Any requests using the max_docs_per_hop parameter must replace it with max_docs_per_query. (6cde2ef)