Ask or search…

Configure entities

After having created a document type through the overview page (see Configure a document type), you will land upon the following page, where you can configure entities for the document type:
You can start creating new entities by clicking on the "+ Create" button at the top or the "Create" button in the middle section.
A new panel will open where you can configure the entity:
After filling in the entity name, one of the following entity classes can be chosen:
  1. 1.
    Text - A text entity is an entity that has a value in a textual form that does not need to be linked to other data. Examples include document dates, addresses, total amounts, ...
  2. 2.
    Composite - A composite entity is a group of other entities, e.g. an order line consisting of different entities such as the product name, product number, quantity, price per unit, .... When creating a composite entity you can select the entities that belong to it in the next step.
  3. 3.
    Paragraph - A paragraph entity is an entity that has a value in a long textual form. Unlike the text entity, a paragraph entity is optimized for longer pieces of text.
  4. 4.
    Regex - For entities that are fixed keywords or follow a fixed pattern, you can define regular expressions.
  5. 5.
    Image - An image entity is for recognizing objects such as handwritten text, and signatures, ... Labeling an object in a document is done by drawing a rectangle around the object.
If you chose a text entity you can also set an entity type. This type will be used for validating and converting the value to a certain format. For example, if you choose the type 'date', Metamaze will validate the value found by the model for this entity and convert it to the format you define yourself. If Metamaze would detect a value for this entity that is not a date (conversion and validation failed) it will be put into the manual intervention module for checking (if this step is enabled).
There are different types for text entities:
  • Regular - This is a text type entity. There is no validation or conversion to a particular format.
  • Number - This is a numerical entity. Choose the desired input format for decimals and thousand separators.
  • Date - This is an entity of the date type. Choose the desired date output format. For a complete list of supported format strings, see this link.
After choosing the appropriate entity type, you can optionally indicate to which composite entity it belongs below "part of composite".
For more information about the other properties of entities, see Entities.