Skip to main content

Reveal Review Publication

Entity models

In the Admin Module, in the left column under STORYBOOK SETTINGS, choose Entity models, and the Entity models view appears:


The Entity models view contains the following:

  • Create model: The Create model button allows you to select an existing custom entity type and put Reveal AI to work building a model based on that entity type. See Model creation below.

  • Model library: Provides access to the entity Model Library where all the published models are available for use. See Model library below for additional information on the storybook-specific view of the Model Library.

  • Entity model/Entity type: This button is used to choose between the Entity model and Entity type views. See Entity type view below.

  • Selection Column (marked by a checkbox): Use this column to choose any available existing model(s) to Run or Publish. Once a choice is made, Run and Publish buttons appear at the top:

  • Model: The name and description of the model.

  • Entity Type: The entity type associated with the model.

  • F1: Broad information retrieval performance of the model – a golden mean average of recall and precision.

  • Recall: Evaluation of the model’s performance in finding all the relevant entities.

  • Precision: Evaluation of the model’s performance in minimizing false positives.

  • Status: Is the model Ready to be published or has it been Published.

  • Entity Examples: The number of entity examples are used to create the model.

  • Segment Examples: The number of segments containing entities.

  • Discarded Examples: The number of examples discarded by the AI model.

  • Build Source: Example set used to build model.

  • Build: Create the entity model based on existing examples.

  • Run: Run the entity model on the current data to generate new annotations.

  • Publish: Send the entity model to the library.

  • Action: Choosing the trash can icon deletes the model.

Entity type view

The Entity model view can be changed to the Entity type view by choosing the Entity model/Entity type button:


If you choose Entity type...

60423331bce2a.png will see the following view:


Which contains the following columns:

  • Visible: A checkmark here determines that this entity is visible to the user.

  • Entity type: The name of the entity type.

  • Action: When you choose the edit icon, the following pop-up appears. The pop-up allows you to modify the entity type name and determine whether it is visible in the storybook.

  • Models: The name of the entity model associated with the entity type.

Model Creation

In the Admin Module, in the left column under STORYBOOK SETTINGS, choose Entity models and then in the main view to the right under the heading “Entity models” choose Create model.


The Create Entity Model window appears:


Enter the following:

  • Name: Choose an appropriate name.

  • Entity Type: Select an existing Entity type from the dropdown list.


    Only Custom Entities will be available for model build.

  • Description: Enter additional information such as genesis or purpose.

Build and Run Model

Once you are happy with the annotations you may choose Build now. For more information on annotations see User Guide, Section 5, Custom Entity Types.


When you select Build now, you will be prompted to choose which entity examples to use to build your model.


You have two options:

  1. All examples. By choosing this option, all annotations associated with your custom entity will be used to build your model. These examples could be from earlier model results, entity search & extract results, and user annotations.

  2. Examples annotated by user. Only examples that are explicitly annotated by the user will be used to build your model. See User Guide, Section 5, Custom Entity Types.

When the model is built the above table will provide information retrieval measurements: F1Recall and Precision. You may now apply the model to your storybook by choosing Run. Go to the Notification icon for status. You may return to the EXPLORING tab to review results. (See User Guide Section 5C Building a Custom Entity Model.)

Publish Model

If you want to post the entity models to your library for use in other storybooks, choose Publish. When you publish an entity model you are sending a copy to the Entity model library. The library is a dynamic repository of entity models that includes the Standard Model (a collection of broadly applicable entity types) and whatever custom entity models have been provided, imported or created. 

Model Library

If you want to add a model from the library to your storybook, press the Model library button.


This storybook-specific view of the Model Library displays as a collection of catalogue cards that show what models are available to add to your storybook (there is an alternate tenant-wide view of the Entity model library described in Section 2 - Tenant Settings > E. Model library):


The full blue ADD buttons (outlined in green) are available to add. The faded blue ADD buttons (outlined in red) are unavailable because they are already in your storybook. The UPDATE button outlined in green is a revised version of a model from another storybook, an outdated version of which you have added to your current storybook. This marks that you have the option of updating this model in your current storybook. 

There are four filter buttons:

  • Find: Enter search text which will query entity model title, entity and notes.

  • Published by: Name of admin who published this model.

  • Order by: Either oldest to newest or newest to oldest.

  • Reset Filters: Clear the filters and view the entire library catalogue.

Entity Model Life Cycle

Once a model is built it can be made available to other storybooks by being published. When you view the library from within another storybook you may add the published model to the current storybook by choosing the ADD button (green outlined above). A published model cannot be added to the storybook whence it came, nor to any storybook to which it has already been added. This is prohibited (as red outlined above) by the ADD button being made unavailable and presented in a faded blue. 

If a model is altered through annotation, in the same storybook from which it originated, and then published, the outdated library version is replaced by the new version. In that case, when you view the library from within another storybook to which the earlier model version has been added, the new library version will appear with an UPDATE button (blue outlined above) instead of the ADD button. This will allow a user of an inherited model to check for updates prior to running or to consider re-running. 

If a model is altered through annotation in a storybook other than the one from which it originated, then when it is published to the library it is a distinct model - not a replacement for the existing one. This is exemplified above by the two models named AmerByKit and PhoneNumbers with different details underneath. 

By this means, the system keeps separate and distinct each model fed by annotations from different projects. 

For more information on managing the Entity model library see Section 2 - Tenant Settings > E. Model library.