- Overview
- Document Understanding Process
- Quickstart tutorials
- Framework components
- ML packages
- Overview
- Document Understanding - ML package
- DocumentClassifier - ML package
- ML packages with OCR capabilities
- 1040 - ML package
- 4506T - ML package
- 990 - ML Package - Preview
- ACORD125 - ML package
- ACORD126 - ML package
- ACORD131 - ML package
- ACORD140 - ML package
- ACORD25 - ML package
- Bank Statements - ML package
- Bills Of Lading - ML package
- Certificate of Incorporation - ML package
- Certificate of Origin - ML package
- Checks - ML package
- Children Product Certificate - ML package
- CMS 1500 - ML package
- EU Declaration of Conformity - ML package
- Financial Statements - ML package
- FM1003 - ML package
- I9 - ML package
- ID Cards - ML package
- Invoices - ML package
- Invoices Australia - ML package
- Invoices China - ML package
- Invoices India - ML package
- Invoices Japan - ML package
- Invoices Shipping - ML package
- Packing Lists - ML package
- Passports - ML package
- Payslips - ML package
- Purchase Orders - ML package
- Receipts - ML Package
- Remittance Advices - ML package
- Utility Bills - ML package
- Vehicle Titles - ML package
- W2 - ML package
- W9 - ML package
- Other Out-of-the-box ML Packages
- Public Endpoints
- Hardware requirements
- Pipelines
- Document Manager
- OCR services
- Deep Learning
- Document Understanding deployed in Automation Suite
- Document Understanding deployed in AI Center standalone
- Licensing
- Activities
- UiPath.Abbyy.Activities
- UiPath.AbbyyEmbedded.Activities
- UiPath.DocumentProcessing.Contracts
- UiPath.DocumentUnderstanding.ML.Activities
- UiPath.DocumentUnderstanding.OCR.LocalServer.Activities
- UiPath.IntelligentOCR.Activities
- UiPath.OCR.Activities
- UiPath.OCR.Contracts
- UiPath.OmniPage.Activities
- UiPath.PDF.Activities
The user interface
The Document Manager interface contains the following panels:
- Management Bar
- Column Fields
- Regular Fields
- Classification Fields
- Document View
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 |
|
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 |
|
There are two search functionalities:
|
|
Delete / Restore |
|
Delete or restore a document. Deleted documents can be found under the deleted filter. |
|
Import |
|
Open Import data dialog box. |
|
Export |
|
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 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 |
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 |
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 |
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. | |
|
Settings |
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.
The exposed search functionality has two parts:
-
Search using the built-in filters: filters the documents based on the batch/category available options from the drop-down menu.
Selecting more options makes the search more restrictive. For example selecting Batch import1 and Deleted is bringing up only the documents imported in the Batch import1 which are deleted.
Take note of combinations that will always return an empty list: selecting Batch import1 and Batch import2 would never return a document since the selection is restrictive and no document can be in two batches at a time.
-
Search in documents using keywords: this search bar filters the information based on a text input. You have to enter the keyword(s) as free text in the Search bar. The search looks for the keyword(s) in a document's content or the document name. Multiple words search returns results when the words are adjacent, excluding any punctuation in between them.
-
Search inside the document: allows you to search for instances of text solely in your current document. The search bar,
, can be found at the bottom left hand side of the screen.
The Settings button has two available options:
- Settings where you can configure the OCR service or Prelabelling
- How to... which has the purpose of a help menu
OCR
In order to import documents into Document Manager, it is mandatory to configure an OCR service.
The following options are available:
This setting is available only for Document Types (Data Manager sessions) created in AI Center. When created in Document UnderstandingTM, this setting is inherited from the Project Settings. If you want to modify these settings in Document UnderstandingTM, go back to the Project view and open Project Settings from the bottom left.
The cloud-based options are:
- UiPath®
Document OCR -
https://du.uipath.com/ocr; - OCR for Chinese, Japanese and Korean
- Google Cloud Vision OCR which has the best language coverage;
- Google Cloud Vision OCR for Japanese optimal for reading Japanese documents;
- Microsoft Read OCR.
Configuring the OCR requires the OCR service to have a URL. Here are the possible URLs you can use:
- public URLs such as
https://du.uipath.com/ocror third-party URLs from Google Vision OCR or Microsoft Read OCR
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.
For more information, check the Cloud and on-premises usage page.
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.
If you already have a model which can extract some of the fields that need labelling, and there are only a few extra fields that require manual labelling, you can save time by using Document Manager’s Prelabelling feature.
Prelabelling merges the results of the Prelabelling endpoint, that you configure in the Prelabelling settings.
The following options are available:
Prelabelling requires that the ML model has a URL. Check out the following possible URLs you can use:
- Public URLs such as
https://du.uipath.com/ie/invoices or https://du.uipath.com/ie/purchase_orders.Visit Public Endpoints to see the full list of endpoints.
- URLs of ML Skills which have been made public in On-premises AI Center or in Cloud AI Center.
The AI Units/Document Understanding API Key. The Prelabelling API key is the Document Understanding API key of the organization where the skill resides.
The key is mandatory for Cloud Document Manager and On-premises Online Document Manager. The key is optional for On-premises Air-gapped Document Manager.
The How to... option opens the Document Manager help menu.
In the help menu you can find the following information:
- 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. |
|
Enter or 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. |
- Create new column field
- Edit field
- Expand/collapse column field values
For more details on column fields, visit this section.
- Create a new regular field
- Edit field
For more details on regular fields, visit this section.
- Create a new classification field
- Edit field
For more details on classification fields, visit this section.
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:
Also, loading failures are also displayed in document view:
