Home / Documentation / Entity Models

Entity Models

zentity relies on objects called entity models to control the execution of entity resolution jobs.

Entity models serve multiple purposes:

  1. They define which attributes map to which fields of which Elasticsearch indices.
  2. They define how to match an attribute for any index field it maps to.
  3. They define which combinations of matching attributes imply a resolution.

Read the entity model specification for specific details on the contents of entity models.


You must provide an entity model when making a resolution request. You can provide it in two ways:

  1. You can embed the entity model in the request under a field called "model".
  2. You can index the entity model using the Models API and reference it by its entity_type.

Option (2) gives you the ability to share, reuse, and build upon existing entity models. You can manage entity models using the Models API. zentity stores entity models in an Elasticsearch index called .zentity-models. Each document in this index represents the entity model for a distinct entity type. The entity type is listed in the _id field of the document. There can be only one entity model for a given entity type. Once you have indexed an entity model, you can use it by setting the entity_type parameter in your requests.

More info


Continue Reading

Basic Usage Entity Model Specification
© 2018 - 2022 Dave Moore.
Licensed under the Apache License, Version 2.0.
Elasticsearch is a trademark of Elasticsearch BV.
This website uses Google Analytics.