Skip to main content
Creating document fields For every entity that you want to extract, a corresponding field should be created in the Document Definition. To create a field:
  1. In the Document Definition Editor, right-click the Document Section name and select Create Field.
  2. Create a Text field.
  3. On the General tab, select the Can have region option.
  4. In the Name field, specify a name for the field (for example, PreambleSegment).
    Important! Field names must not contain spaces or non-English characters or start with a number.
Repeat the above steps for each entity.
If segmentation is used, a separate text field should be created for each segment.
For each segment from which entities will be extracted:
  • Create a non-repeating field in a repeating group.
  • Select the Text segment option in the field properties.
  • Select the Allow multiple regions option if some of the segments begin and end on different pages.
Creating a segmentation NLP model Segmentation improves the accuracy and speed of entity extraction. Segmentation is optional. A special NLP model is required to segment documents.
Important! You can have only one segmentation model for each document section. To create a segmentation model:
  1. In the Document Definition Editor, right-click the Document Section name.
  2. Select Properties…
  3. In the dialog box the opens, click the NLP tab and then click Create…
  4. In the Name field, specify a name for your segmentation model (for example, SegmentationModel).
  5. In the Model type field, choose Segmentation.
  6. In the Language list, select the required language.
  1. Click Next…
  2. In the dialog box that opens, specify all the fields into which the segments will be extracted.
  3. Click OK.
Once you have created a segmentation model, you need to train it on some sample documents.
The Allow training option allows you to train your NLP model during document processing. Your NLP model will be trained when you train field extraction using a field extraction training batch. Training results can be either disabled or deleted. To disable training results, right-click the training batch and select the Disabled item on the shortcut menu. To delete training results, right-click the training batch and select the Delete item on the shortcut menu.
Creating an entity extraction NLP model To extract entities, you need an entity extraction NLP model that has been trained on manually marked up documents. To create an NLP model:
  1. In the Document Definition Editor, open the document section properties and click the NLP tab.
  2. Click Create…
  3. Specify a Name for your NLP model (for example, EntitiesExtraction).
  4. For the data source, select either a section (if no segmentation is used) or a segment (if have chosen to use segmentation).
  5. In the Model type field, choose Extraction.
  6. In the Language list, select the required language.
  7. Click Next…
  8. Choose the result fields that will be extracted from the selected document section or segment.
Repeat steps 1 through 9 for each document segment or section from which entities should be extracted.
  1. Click Document Definition > Save to save your Document Definition.
  2. Click Document Definition > Close to close the Document Definition editor.
  3. Click Document Definition > Publish to publish your Document Definition.
Once you have created an entity extraction NLP model, you need to train it on some sample documents.
The Allow training option allows you to train your NLP model during document processing. Your NLP model will be trained when you train field extraction using a field extraction training batch. Training results can either be disabled or deleted. To disable training results, right-click the batch and select the Disabled item on the shortcut menu. To delete training results, right-click the batch and select the Delete item on the shortcut menu.