document-understanding
2023.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
- 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
- Install and use
- First run experience
- Deploy UiPathDocumentOCR
- Deploy an out-of-the-box ML package
- Offline bundles 2023.10.10
- Offline bundles 2023.10.9
- Offline bundles 2023.10.8
- Offline bundles 2023.10.7+patch1
- Offline bundles 2023.10.7
- Offline bundles 2023.10.6
- Offline bundles 2023.10.5
- Offline bundles 2023.10.4
- Offline bundles 2023.10.3
- Offline bundles 2023.10.2
- Offline bundles 2023.10.1
- Offline bundles 2023.10.0
- Use Document Manager
- Use the Framework
- 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 Sep 15, 2025
Depending on the models you want to use, you need the following:
- For models 2022.10 and newer:
- Download the needed Document
UnderstandingTM bundle. Here are the links for all
the available bundles. The du bundle contains information about all models
included into a specific version. For example, the
dusemistructured-2023.10.0.tar.gzcontains information about all out-of-the-box pre-trained ML Packages included in the 2023.10.0 version.
- Download the needed Document
UnderstandingTM bundle. Here are the links for all
the available bundles. The du bundle contains information about all models
included into a specific version. For example, the
- For models 2022.4 and older (
python37duv3andpython37duv4):- All ML Packages are provided as a
.zipfile which is uploaded directly as a Custom Package in AI Center. To download the models, contact your Account Manager, CSM, or Support to receive a download link per package. - Download the needed Document Understanding bundle. Here are the links for all the available bundles.
- All ML Packages are provided as a
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-2023.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/2023.10.0/dusemistructured-2023.10.0.tar.gz'wget -O ~/du-ondemand.tar.gz 'https://download.uipath.com/automation-suite/2023.10.0/dusemistructured-2023.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 in the ML packages offline installation page from the AI Center
User Guide to upload them to AI Center. Both ML package
zip and
metadata json files are needed for this procedure.
Access Form Extractor and Intelligent Keyword Classifier, with the following 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 desired Document Understanding images
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
Rename 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 external docker registry
Push 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.02023.10.10
| Document Understanding bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10-06.05-rc05 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10-06.05-rc05 |
| OCR for Chinese, Japanese, Korean |
|
| Extended Languages OCR |
|
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10-06.05-rc05 |
| Out of the box pre-trained ML packages | aicenter/du-semistructured:v23.10-06.05-rc05 |
2023.10.9
| Document Understanding bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10-03.14-rc02 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10-03.14-rc02 |
| OCR for Chinese, Japanese, Korean |
|
| Extended Languages OCR |
|
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10-03.14-rc02 |
| Out of the box pre-trained ML packages | aicenter/du-semistructured:v23.10-03.14-rc02 |
2023.10.8
| Document Understanding Bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10-01.28-rc07 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10-01.28-rc07 |
| OCR for Chinese, Japanese, Korean |
|
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10-01.28-rc07 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10-01.28-rc07 |
2023.10.7+patch1
| Document Understanding Bundle | Image |
|---|---|
| OCR for Chinese, Japanese, Korean |
|
2023.10.7
| Document Understanding Bundle | Image |
|---|---|
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10-12.01-rc01 |
2023.10.6
| Document Understanding Bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10-09.25-rc08 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10-09.25-rc08 |
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10-10.15-rc03 |
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10-09.25-rc08 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10-09.25-rc08 |
2023.10.5
| Document Understanding Bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10-rc28 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10-rc28 |
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10-rc58 |
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10-rc28 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10-rc28 |
2023.10.4
| Document Understanding Bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10.4-rc125 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10.4-rc125 |
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10.4-rc45 |
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10.4-rc125 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10.4-rc125 |
2023.10.3
| Document Understanding Bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10.3-rc04 |
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10.3-rc20 |
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10.3-rc04 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10.3-rc04 |
2023.10.2
| Document Understanding Bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10.2-rc22 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10.2-rc22 |
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10.2-rc13 |
| DocumentClassifier | aicenter/du-ml-document-type-text-classifier:v23.10.2-rc42 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10.2-rc22 |
2023.10.1
| Document Understanding Bundle | Image |
|---|---|
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10.1-rc19 |
2023.10.0
| Document Understanding Bundle | Image |
|---|---|
| UiPathDocumentOCR | aicenter/du-doc-ocr:v23.10.0-rc68 |
| UiPathDocumentOCR_CPU | aicenter/du-doc-ocr-cpu:v23.10.0-rc68 |
| OCR for Chinese, Japanese, Korean | du/du-cjk-ocr-proxy:v23.10.0-rc82 |
|
Out-of-the-box Pre-trained ML Packages | aicenter/du-semistructured:v23.10.0-rc68 |
- 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
- 2023.10.10
- 2023.10.9
- 2023.10.8
- 2023.10.7+patch1
- 2023.10.7
- 2023.10.6
- 2023.10.5
- 2023.10.4
- 2023.10.3
- 2023.10.2
- 2023.10.1
- 2023.10.0
