document-understanding
2024.10
false
- 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
- 1040x - ML package
- 3949a - ML package
- 4506T - ML package
- 709 - ML package
- 941x - ML package
- 9465 - 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 China - ML package
- Invoices Hebrew - 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
- Insights dashboards
- 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
Document Understanding User Guide
Last updated Nov 11, 2024
ML Packages Offline Installation
Download the needed Document Understanding bundle. Here are the links for all the available
bundles. The Document Understanding bundle contains information about all models
included into a specific version. For example, the
dusemistructured-2024.10.0.tar.gz contains information about all
out-of-the-box pre-trained ML Packages included in the 2023.4.0 version.
Offline installations are requiring that the downloaded du bundle to be renamed in the command
line into
du-ondemand.tar.gz. For instance, if you downloaded the du
bundle named dusemistructured-2024.10.0.tar.gz, at installation time
you need to rename it as du-ondemand.tar.gz.
- For Windows machines, directly download through the bundle link and rename the file to
du-ondemand.tar.gz -
For Linux machines, from the machine having access to the internet, download the needed bundle following the below command:
wget -O ~/<bundle-name.tar.gz> 'bundle-link'wget -O ~/<bundle-name.tar.gz> 'bundle-link'Here's an example of how to download the needed bundle for Linux:
wget -O ~/du-ondemand.tar.gz 'https://download.uipath.com/automation-suite/2024.10.0/dusemistructured-2024.10.0.tar.gz'wget -O ~/du-ondemand.tar.gz 'https://download.uipath.com/automation-suite/2024.10.0/dusemistructured-2024.10.0.tar.gz' -
Copy the following bundle to the
/uipath/tmpfolder on the main machine of the cluster (where the install took place):scp ~/<bundle-name.tar.gz> <username>@<node dns>:/uipath/tmp/scp ~/<bundle-name.tar.gz> <username>@<node dns>:/uipath/tmp/ -
Connect to this main machine and load the bundle:
./configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/du.tar.gz" --offline-tmp-folder "/uipath/tmp"./configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/du.tar.gz" --offline-tmp-folder "/uipath/tmp"
After downloading and installing the models, follow the steps described here to upload them to AI Center.
Access Form Extractor and Intelligent Keyword Classifier, with the below public URL:
<FQDN>/du_/svc/formextractor<FQDN>/du_/svc/intelligentkeywords
Note: When using a public URL, replace the
<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.
Follow these steps to upload a Document Understanding bundle to your external docker registry:
- Pull the desired DU image from the UiPath® registry hosted on registry.uipath.com
- Rename the image host as per your docker registry name.
- Push the image to external docker registry
Pull the images from UiPath® registry by running these
commands:
docker pull <uipath_registry_server>/<image_name>docker pull <uipath_registry_server>/<image_name>Here's an example of how to pull the image of the UiPathDocumentOCR bundle from a registry called registry.uipath.com:
docker pull registry.uipath.com/aicenter/du-doc-ocr:v23.10.0docker pull registry.uipath.com/aicenter/du-doc-ocr:v23.10.0Rename the image host by running the following command:
docker tag <uipath_registry_server>/<image_name> <your_registry_server>/<image_name>docker tag <uipath_registry_server>/<image_name> <your_registry_server>/<image_name>Here's an example of how to rename the image of the UiPathDocumentOCR bundle from a registry called registry.uipath.com to a registry called registory.mycompany.com:
docker tag registry.uipath.com/aicenter/du-doc-ocr:v23.4.0-rc70 registory.mycompany.com/aicenter/du-doc-ocr:v23.10.0docker tag registry.uipath.com/aicenter/du-doc-ocr:v23.4.0-rc70 registory.mycompany.com/aicenter/du-doc-ocr:v23.10.0Push the image to your external docker registry by running the following command:
docker push <your_registry_server>/<image_name>docker push <your_registry_server>/<image_name>Here's an example of how to push the image of the UiPathDocumentOCR bundle to an external docker registry:
docker push registory.mycompany.com/aicenter/du-doc-ocr:v23.10.0docker push registory.mycompany.com/aicenter/du-doc-ocr:v23.10.0|
Document Understanding Bundle |
Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10.0 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10.0 |
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10.0 |
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10.0 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10.0 |
|
Dulv4 | aicenter/python37duv4:23.10.0 |
|
Dulv3 | aicenter/python37duv3:23.10.0 |
|
Dulv2 | aicenter/python37duv2:23.10.0 |
- Getting started
- Install the offline bundle
- Upload the model to AI Center
- Form Extractor and Intelligent Keyword Classifier
- Upload a Document Understanding™ bundle to an external docker registry
- Pull the desired Document Understanding images
- Rename the image host
- Push the image to external docker registry
- Images for each Document Understanding bundle
