- Overview
- Getting Started
- Activities
- UiPath.Abbyy.Activities
- UiPath.AbbyyEmbedded.Activities
- UiPath.DocumentProcessing.Contracts
- UiPath.DocumentUnderstanding.Activities
- UiPath.DocumentUnderstanding.ML.Activities
- UiPath.DocumentUnderstanding.OCR.LocalServer.Activities
- UiPath.IntelligentOCR.Activities
- UiPath.OCR.Activities
- UiPath.OCR.Contracts
- UiPath.OmniPage.Activities
- UiPath.PDF.Activities
- Insights Dashboards
- Document Understanding Process
- Framework Components
- ML Packages
- Overview
- Document Understanding - ML Package
- DocumentClassifier - ML Package
- ML Packages With OCR Capabilities
- 1040 - ML Package
- 1040 Schedule C - ML Package
- 1040 Schedule D - ML Package
- 1040 Schedule E - 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
- BillsOfLading - 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
- InvoicesAustralia - ML Package
- InvoicesChina - ML Package
- InvoicesIndia - ML Package
- InvoicesJapan - ML Package
- Invoices Shipping - ML Package
- Packing Lists - ML Package
- Payslips - ML Package
- Passports - ML Package
- Purchase Orders - ML Package
- Receipts - ML Package
- RemittanceAdvices - ML Package
- UB04 - 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
- Traffic limitations
- OCR Configuration
- Pipelines
- Deep Learning
- Licensing
Introduction
Document Understanding is the main starting point for creating new projects. You can use it for structured or semi-structured documents, and also along with pre-trained models. You can always start a training session from scratch, validate your documents, and customize the projects as needed.
Here you can find a list of all the created projects, with specific details. You can sort the projects alphabetically, or by date, create a new project, and customize the page view.
Presents the list of all created projects. There are three types of sorting for Projects:
- Alphabetically in ascending order
- Alphabetically in descending order
- By creation date.
The default sorting order is by the creation date.
Once a project is created you can select the type of the document. There are two options:
- Using Forms AI (fixed layout format) - intended for Forms AI
- Using Semi-Structured AI - intended for
Document Manager
If you want to delete a document type, then open your project, select the document type that you want to delete, open the Action Menu and click on the Delete option.
Use this function to customize the amount of details available for the Projects list. Here's the full list of details that can be displayed for each created project.
- Name - Displays the name of the project.
- Document types - Displays the type of documents used for each project.
- Extractors - Displays the number of extractors used for each project.
- Documents processed - Displays the number of processed documents for each project.
- Creation Date - Displays the creation date for each project.
- Refresh - Refreshes the information in the displayed columns for all projects.
Create a new project by using the Create project button. Clicking on the Create project opens a new popup window. To use the modern experience, select Modern. This experience is currently in public preview.
When a new project is created, the following information is required:
Option |
Description |
Field status |
---|---|---|
Name | Provide a name for the new project. | Mandatory |
Building experience | Choose between Classic or Modern experience. The modern experience is currently in public preview. | Mandatory |
Enable OCR for Chinese, Japanese or Korean Languages | Checking this box will configure the UiPath Chinese Japanese Korean OCR as the OCR engine used in this project. You can change this later from the project settings. | Optional |
After creating a project, you can change the project settings and configure advanced options. To do so, select your project and go to Project settings.
Option | Description | Field status |
---|---|---|
Description | Provide more details about the project. | Optional |
OCR method |
Select the OCR method for the new project. Choose between the following options:
|
Mandatory |
OCR API Key |
Provide the OCR API Key for the chosen OCR method. If the OCR method is UiPath OCR, or UiPath Chinese, Japanese, Korean OCR, then the value of this field is available on the cloud platform by going to |
Optional |
OCR URL |
Provide the OCR URL corresponding to the chosen OCR method. Here's the list of the OCR URLs corresponding to the UiPath OCR method. Here is a list of other commonly used OCR URLs: Microsoft Read 3.2 Azure:
<Azure_resource_Endpoint>/vision/v3.2/read/analyze Microsoft Read 3.2 On-Prem:
http://<IP_addr>:<port_number>/vision/v3.2/read/analyze Microsoft Read 2.0 Azure:
<Azure_resource_Endpoint>/vision/v2.0/read/core/asyncBatchAnalyze Microsoft Read 2.0 On-Prem:
http://<IP_addr>:<port_number>/vision/v2.0/read/core/Analyze |
Mandatory |
Apply OCR on PDF |
Establishes if the OCR process should be applied or not to PDF documents. If set to Yes, the OCR is applied to all PDF pages of the document. If set to No, the OCR is not applied to any pages and returns only the text embedded in the PDF . When set to Auto OCR applies only to the scanned pages of the document. The default value is Auto. |
Mandatory |
A project linked to AI Center is easily identified by the AI Center icon next to the project name.
If you want to delete a project that's linked to AI Center, then the deleting procedure automatically deletes it from AI Center as well.
- Build: Upload documents, train document classification and extraction models, and receive recommended next steps for imprpoving model performance.
- Measure: Review the overall status of your project and verify the performance of classification and extraction models.
- Publish: Publish a version of the project containing the models, consume the models using activities or APIs.
- Monitor: Review the performance metrics of your automation, and view an audit trail of processed documents.
The following options are applicable throughout the entire interface of Document Understanding.
Search option enables you to initiate a search among the available list of projects, document types, or extractors. Search is active separately for each selected tab, meaning that if you want to search for an extractor, you should select the Extractors tab. Same applies for Document types. Start a search by typing the name of the project inside the Search bar.
Refresh - Refreshes the list of projects.
Remove project - Deletes the selected project. The Remove project button becomes visible only after opening the action menu.
Page scrolling - Easy scroll through the list of project pages, document types, or extractors. Go page by page or skip directly to the first/last page.
Items per page - Select the number of projects, document types, or extractors displayed per project page.
REST API - Opens the REST API framework capabilities.
In the Licensing category of this guide, you can check the following information:
If you want to integrate your Document Understanding project into an RPA workflow, make sure that you follow the steps below:
-
Open UiPath Studio and create a new project by selecting Document Understanding Process from the templates list.
The following packages should also be added to your UiPath Studio project:
- UiPath.IntelligentOCR.Activities
- UiPath.OCR.Activities
- UiPath.DocumentUnderstanding.OCR.LocalServer
- UiPath.DocumentUnderstanding.ML.Activities
- UiPath.Omnipage.Activities
Make sure Document Understanding is enabled on your tenant. To do so, follow these steps:
- Go to your Automation Cloud™ Administration panel.
- Select the tenant where you want to enable the Document Understanding service.
- Select Services.
- On the Document Understanding card, click on the three-dot icon ⁝ and select Enable.
Once the Document Understanding is enabled, the Document Understanding tab appears on the left navigation bar.