- 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
- 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
- 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
- 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
- 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
Install and use
This page describes how to deploy and configure Document UnderstandingTM, as well as special instructions on how to use Document UnderstandingTM on Automation Suite.
Document Understanding has a dependency on AI Center, meaning that AI Center always needs to be installed if Document Understanding is installed.
Also, Orchestrator must be activated before using Document Understanding.
Before starting the Document Understanding installation, make sure to check and satisfy all requirements for Automation Suite for single-node and for multi-node here.
A GPU is strongly recommended for Document Understanding in one of the following scenarios:
-
If you retrain the Document Understanding models (DocumentUnderstanding - the general model, Invoices, Receipts, etc.) on AI Center.
Training on CPU is 5-7 times slower and model performance degrades compared to training on GPU.
-
If you run UiPathDocumentOCR (non-edge version) on AI Center to process more than 2 million pages a year.
If you do not use a GPU, slow performance may impact the product experience.
For more details about how to provision a GPU, see Adding a dedicated agent node with GPU support.
Document Understanding requires the FullTextSearch feature to be enabled on the SQL server. Otherwise, the installation fails without an explicit error message.
For more information on installing Document Understanding in an online environment, see the following guides:
The process is mostly the same as installing other services, and the only requirement is to ensure that AI Center and Document Understanding are enabled.
- If you are using the interactive installer, please make sure to select both products following the steps.
-
If you are not using the interactive installer, please set AI Center and Document Understanding enabled in the config file before installation, or in ArgoCD after installation.
Sample configuration file is included in the Document Understanding configuration file page.
For more information on installing Document Understanding in an offline environment, see the following guides:
The changes below are required for a successful installation of Document Understanding in an offline environment:
-
Make sure that AI Center and Document Understanding are set to enabled in the config file before installation, or in ArgoCD after installation. Please make sure handwriting is enabled as well in the config file if you want to use the feature.
Sample configuration file is included in the Document Understanding configuration file page.
-
Make sure that the Document Understanding bundle is downloaded and installed.
For more information on downloading and installing the Document Understanding bundle, check the ML Packages Offline Installation page.
Check the Document Understanding configuration file here.
Access Form Extractor and Intelligent Keyword Classifier, with the below public URL:
<FQDN>/du_/svc/formextractor<FQDN>/du_/svc/intelligentkeywords
<FQDN> placeholder with the actual environment information.For example <FQDN>/du_/svc/formextractor becomes https://servicefabricserver.domain.com/du_/svc/formextractor when used in a workflow.
As a post-installation operation, you can enable or disable Document Understanding. More details can be found here.
If you want to use the OCR for Chinese, Japanese, Korean endpoint in an offline environment, you need to install the offline bundle by following these instructions, and once the bundle is installed, you have to enable the OCR in ArgoCD.
- When OCR for Chinese, Japanese, Korean is used in Document Understanding, make sure that you've configured the activity with the public endpoint of the OCR, and the Document Understanding API Key.
- OCR for Chinese, Japanese, Korean is only supported in Document Understanding deployed in Automation Suite. This is not supported in Document Understanding deployed in AI Center connected to an external Orchestrator.
Here are the steps that you need to follow in order to enable the OCR in ArgoCD:
- Access ArgoCD.
- Open the Document Understanding framework.
- Click on the Parameters tab and go to
du-cjk-ocr.enabled. - Click on the Editbutton, set the value to
TRUE, and click on the Save button.
{Cluster_FQDN}/du_/cjk-ocr/.
Check the Document Understanding-related issues here.
