Subscribe

UiPath Document Understanding

UiPath Document Understanding

Document Manager

UiPath Document Manager is a lightweight web application that allows users to prepare, review and make corrections to datasets required for Training and Evaluation of Document Understanding Machine Learning models. It enables multiple users to perform a variety of operations:

Define and configure the fields to be extracted by an ML model.
Import documents for labeling.
Prelabel documents using a preexisting ML model such as Invoice Extraction or Receipt Extraction provided by UiPath out-of-the-box, or by using a model trained using AI Center.
Label documents.
Export documents in the format expected by the AI Center Training pipelines.

Create new session


Important

When a Document Manager Session is created for the first time in a project, you need to link it to the AI Center project.

685685

Once a project is created and opened, you can create a new Document Manager session by clicking on the New button and selecting the Using Semi-Structured AI option. A new window opens requesting additional information.

19121912

Here are the available options for when creating a new Document Manager session. By filling in these values you obtain an estimate of the recommended size of the dataset to be used as a starting point.
Also, by selecting the Out-of-the-box document type, your schema is automatically populated and configured to allow you to benefit from the pre-trained models available in AI Center.
In addition, the Prelabelling endpoint is automatically populated with the appropriate endpoint, making it more convenient for you to use Prelabelling immediately after opening the new Document Type.

506506

Option

Description

Name (Mandatory)

Provide a name for the new document type.

Out-of-the-box document type (Mandatory)

Select one of the pre-trained out-of-the-box document types available in the dropdown list.

Out-of-the-box regular fields (Optional)

Select which of the pre-defined regular fields you would like to create for your schema

Out-of-the-box column fields (Optional)

Select which of the pre-defined column fields you would like to extract from your documents.

Custom regular fields (Optional)

Enter the number of additional regular fields you would like to extract from your documents.

Custom column fields (Optional)

Enter the number of additional column fields you would like to extract from your documents.

Number of languages (Optional)

Enter the number of languages for the documents you need to extract.

Number of layouts (Optional)

Enter the number of layouts for the documents you need to extract.

📘

Note:

Selecting a document type generates a recommended number of pages that need to be used for the dataset.

The User Interface

The Document Manager interface contains the following panels:

Management Bar


Displayed at the top of the page in Document Manager.

Enables you to perform multiple operations: navigate in between documents, delete/restore a document, search/filter documents, run AI model predictions, import and export documents.

Here are the items available in the management bar:

Item

Icon

Description

Navigation

navigatenavigate

Navigate between documents that match the active filter.

In between the two arrows, a counter is displayed. It illustrates the number of the current document out of the total number of documents that match the active search/filter.

Search

searchsearch

Search or filter documents. Filter is also applied when exporting documents. You can also filter by words from a document or by document names.

Delete / Restore

deletedelete / restorerestore

Delete or restore a document. Deleted documents can be found under the deleted filter.

Import

importimport

Open Import data dialog box.

Export

exportexport

Open Export files dialog box.

Document name and type

n/a

The name of the currently active document and its type.

There are three type of documents:
Training document
Validation document
Evaluation document

Training and Validation documents are part of training datasets used by Training Pipelines.

Evaluation documents are ignored by Training Pipelines and are intended to only be used by Evaluation pipelines in AI Center. These documents are the ones that were marked as evaluation by selecting the Mark this an evaluation set checkbox in the Import data dialog box.

Download

documentdocument

The option is available in the drop-down next to the document name.

Click the icon to download a Zip file containing the original document. Besides the original document, all pages converted internally by Document Manager to .jpeg images are downloaded as well.

Permanently delete

permanently deletepermanently delete

The option is available in the drop-down next to the document name.

Permanently deletes individual files. The .pdf and all its .jpeg images are deleted from the AI Center dataset and all the metadata is deleted from the database.

When clicking the button, a pop-up message appears asking you if you are sure you want to permanently delete the document. Click OK to continue or Cancel to revert to the previous screen.

Batch name

n/a

The name of the current batch.

Session name

n/a

The name of the current session.

Predict

predictpredict

Run AI model predictions and display the results.

After configuring Prelabelling, the button is enabled in the management bar. Click it to prelabel the current document.

The Predict functionality discards all manually edited field values for all field types and deletes all tags from the document.

At the moment, using the Predict option with Public Endpoints prelabels only the first 10 pages of a document. This is a known issue and a fix is in the working. Using the Predict option with ML Skills in AI Center, however, does not impose such a limitation.

Settings

settingssettings

Configure OCR and Prelabelling settings or access the How to... panel. See more details below.

Let's go a little bit deeper in understanding the difference between Delete and Permanently Delete options.

  • The Delete option deletes the files, but not removing them entirely from your project. The deleted files can still be found under the deleted filter from the Search bar and restored by using the Restore option.
  • The Permanently Delete option deletes the selected files without any possibility of restoring them.
    Observe the use of both options in the below GIF:
12801280

The settings button has two available options:

OCR


In order to import documents into Document Manager, it is mandatory to configure an OCR service.

808808

The following options are available:

OCR method

The cloud-based options are:

  • UiPath Document OCR - https://du.uipath.com/ocr;
  • Google Cloud Vision OCR which has the best language coverage;
  • Google Cloud Vision OCR for Japanese optimal for reading Japanese documents;
  • Microsoft Read OCR.

OCR URL

Configuring the OCR requires the OCR service to have a URL. Here are the possible URLs you can use:


OCR key

The corresponding API Key for the selected OCR engine. For example, for UiPath Document OCR, you need to use the Document Understanding API Key. Mandatory for Document Manager Cloud and Document Manager On-Prem Online. It is not required for Document Manager On-Prem Air-gapped.


Apply OCR on PDFs

Establishes if the OCR process should be applied or not to PDF documents. If set to True, the OCR is applied to all PDF pages of the document. If set to False, only digitally typed text is extracted. When set to Auto evaluates if the document requires to apply the OCR algorithm depending on the input document. The default value is Auto.


Prelabelling


If you already have a model which can extract some of the fields that need labeling, and there are only a few extra fields that require manual labeling, you can save a lot of time by using Document Manager’s Prelabelling feature.

849849

The following options are available:

Prelabelling URL

Prelabelling requires the ML model has a URL. Here are the possible URLs you can use:


Prelabelling key

The Document Understanding API Key. Mandatory for Document Manager Cloud and Document Manager On-Prem Online. It is not required for Document Manager On-Prem Air-gapped.


How to...


The How to... option accesses the Document Manager help menu.

19101910

Here you can find:

  • The Document Manager version
  • The Documentation link leading to this documentation page.
  • The Labeling Controls section which displays the controls to be used when handling data.
  • The Document Shortcuts section which displays the shortcuts used to perform various operations such as navigation and UI scaling.
  • The Configuration section which displays details about the instance configuration as performed during installation.

Labelling Controls

Command

Description

Left Click

Selects boxes. If used together with the field's hotkey, it assigns the selected information to the field.

Backspace / Delete

Removes the tagged value of a field.

Right Click

Displays the OCR text and current label.

Backslash

Groups or ungroups table rows which span multiple lines of text.

Document Shortcuts

Shortcut

Description

Alt + Arrow Left / Arrow Right

Navigates between documents.

Alt + Delete

Deletes or recovers a document.

Ctrl + Scroll

Changes the document scaling by zooming in or out.

Column Fields


Column fields have the following options:

  • Create new column field create_fieldcreate_field
  • Edit field edit_fieldedit_field
  • Expand/collapse column field values expand_collapse_column_fieldexpand_collapse_column_field

For more details on column fields, visit this section.

Regular Fields


Regular fields have the following options:

  • Create a new regular field create_fieldcreate_field
  • Edit field edit_fieldedit_field

For more details on regular fields, visit this section.

Classification Fields


Classification fields have the following options:

  • Create a new classification field create_fieldcreate_field
  • Edit field edit_fieldedit_field

For more details on classification fields, visit this section.

Document View


For multi-page documents, you can scroll naturally through the pages as in any PDF viewer. To zoom in or out, use Ctrl + mouse scroll.

You can label documents by selecting the word boxes and assigning them to a field by pressing a key. You can also right-click the word box and verify the extracted information.
For more details on how to label documents, visit this page.

When you open a new Document Manager session or when you have an empty filter, certain guidelines are displayed in document view:

896896

Also, loading failures are also displayed in document view:

11841184

Updated 21 days ago


Document Manager


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.