- Getting Started
- Framework Components
- ML Packages
- Pipelines
- Data Manager
- OCR Services
- Document Understanding deployed in Automation Suite
- Document Understanding deployed in AI Center standalone
- Deep Learning
- Licensing
- References
- UiPath.Abbyy.Activities
- UiPath.AbbyyEmbedded.Activities
- UiPath.DocumentUnderstanding.ML.Activities
- UiPath.DocumentUnderstanding.OCR.LocalServer.Activities
- UiPath.IntelligentOCR.Activities
- UiPath.OCR.Activities
- UiPath.OCR.Contracts
- UiPath.DocumentProcessing.Contracts
- UiPath.OmniPage.Activities
- UiPath.PDF.Activities
Document Understanding User Guide
Create and Configure Fields
Fields cannot be renamed, so please think carefully before naming a field. If, however, there are fields that you later decide you do not want to use for training an ML model, you can either delete them or you can always hide them using the Hidden checkbox in the Edit field window.
A line item Description or Unit Price on an invoice document would be examples of Column fields.
- Click in the table section at the top of the page to add a new Column field. The Create Column Field window is displayed.
- Fill in a unique name for the field in the Enter unique field name field. The field does not accept uppercase letters. It can only contain lowercase letters, numbers, underscore
_
and dash-
. - Click Create. The Edit Field window is displayed.
- From the Content Type drop-down, select the content type.
- From the Scoring drop-down, select the measure used to determine accuracy when running evaluations of model predictions.
- Click the Hotkey field and press a key on your keyboard to automatically populate it.
- Fill in the hex code of the desired field color on the Color field.
- Select the Split items checkbox if you want this field to be used as a delimiter between line items or rows in a table. Any line on which this field appears is considered to be a new line item or row in the table. Most commonly this is used on Line Amount fields on Invoice line items.
- Select the Hidden checkbox if you do not want this field to be part of exported datasets.
- Click Save to save your settings.
Click the Edit field button. The available options for column fields can be found in the table below.
Option |
Description |
---|---|
Content type |
The content type of a field:
|
Shortcut |
The shortcut key for the field. One or two keys allowed. |
Color |
The color for the field in hex format. If the value is not valid, a new one is generated. |
Scoring |
The measure used to determine accuracy when running evaluations of model predictions. It can only be configured for string content type. All other content types use an Exact Match scoring strategy. Options:
|
Split items |
Select this checkbox if you want this field to be used as a delimiter between line items or rows in a table. Any line on which this field appears is considered to be a new line item or row in the table. Most commonly, this is used on Line Amount fields on Invoice line items. |
Hidden |
Select this checkbox if you do not want this field to be part of exported datasets. |
These are fields which appear only once on a given document. A line item Invoice Number or Total Amount on an invoice document would be examples of Column fields.
- Click on the right pane in the Regular Fields section. The Create Regular Field window is displayed.
- Fill in a unique name for the field in the Enter unique field name field. The field does not accept uppercase letters. It can only contain lowercase letters, numbers, underscore
_
and dash-
. - Click Create. The Edit Field window is displayed.
- Select the content type from the Content Type drop-down.
- Select the post processing mechanism in case the model predicts more than one instance of a field on a given page from the Post processing drop-down.
- Click the Hotkey field and press a key on your keyboard to automatically populate it.
- In the Color field, fill in the hex code of the desired field color o
- From the Multi page drop-down, select the data retrieval strategy. This option is used in case that fields appear on a few different pages of a multi-page document. This option defines how the model decides which one to return.
- From the Scoring drop-down, select the measure used to determine accuracy when running evaluations of model predictions.
- Select the Multi line checkbox if the field to be checked against might span across multiple text lines, such as addresses or descriptions. If this option is not selected, only the first line is returned.
- Select the Hidden checkbox if you do not want this field to be part of exported datasets.
- Click Save to save your settings.
Click the Edit field button. The available options for regular fields can be found in the table below.
Option |
Description |
---|---|
Content type |
The content type of a field:
|
Post processing |
The post-processing mechanism. If the model predicts more than one instance of a field on a given page, the model returns:
|
Shortcut |
The shortcut key for the field. One or two keys allowed. |
Color |
The color for the field in hex format. If the value is not valid, a new one is generated. |
Multi page |
The data return strategy in case a field appears on different pages of a multipage document.
|
Scoring |
The measure used to determine accuracy when running evaluations of model predictions. It can only be configured for string content type. All other content types use an Exact Match scoring strategy. Options:
|
Multi line |
Select this checkbox for fields which may span across multiple text lines (addresses or descriptions), otherwise, only the first line is returned. |
Hidden |
Select this checkbox if you do not want this field to be part of exported datasets. |
Data points which refer to a document as a whole. For instance, the Expense Type of a receipt (Food, Hotel, Airline, Transportation) or the Currency of an invoice (USD, EUR, JPY) would be examples of Classification fields.
- Click on the right pane in the Classification Fields section. The Create Classification Field window is displayed.
- Fill in a unique name for the field in the Enter unique field name field. The field does not accept uppercase letters. It can only contain lowercase letters, numbers, underscore
_
and dash-
. - Click Create. The Edit Field window is displayed.
- In the text area, fill in the list of classes and type the names as a comma separated list.
- Click Save to save your settings.
:
(option 1 : description 1).
To delete a classification field, follow these steps:
- Click the Edit field button corresponding to the classification field you want to delete.
- Click the Delete button.
- Type the exact name of the field.
- Click OK.
- The classification field and its associated labeled data is deleted.