document-understanding
2024.10
true
UiPath logo, featuring letters U and I in white

Document Understanding User Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Dec 18, 2024

ML Packages Offline Installation

Getting started

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.

Install the offline bundle

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.
  1. For Windows machines, directly download through the bundle link and rename the file to du-ondemand.tar.gz
  2. 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'
  3. Copy the following bundle to the /uipath/tmp folder 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/
  4. 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"

Upload the model to AI Center

After downloading and installing the models, follow the steps described here to upload them to AI Center.

Form Extractor and Intelligent Keyword Classifier

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.

Upload a Document Understanding™ bundle to an external docker registry

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:v24.10-10.3-rc02docker pull registry.uipath.com/aicenter/du-doc-ocr:v24.10-10.3-rc02

Rename 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:v24.10-10.3-rc02 registory.mycompany.com/aicenter/du-doc-ocr:v23.10.0docker tag registry.uipath.com/aicenter/du-doc-ocr:v24.10-10.3-rc02 registory.mycompany.com/aicenter/du-doc-ocr:v23.10.0

Push 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:v24.10.0docker push registory.mycompany.com/aicenter/du-doc-ocr:v24.10.0

Images for each Document Understanding bundle

2024.10.1

Document Understanding Bundle

Image

UiPathDocumentOCRaicenter/du-doc-ocr:v24.10-11.21-rc12
UiPathDocumentOCR_CPUaicenter/du-doc-ocr-cpu:v24.10-11.21-rc12
Extended Languages OCR

du/du-extended-ocr-proxy:v24.10-12.03-rc04

du/uipath-ocr-extended:v24.10-12.03-rc04

du/du-extended-ocr-reporting:v24.10-12.03-rc04

DocumentClassifieraicenter/du-ml-document-type-text-classifier:v24.10-11.21-rc12

Out-of-the-box Pre-trained ML Packages

aicenter/du-semistructured:v24.10-11.21-rc12

2024.10.0

Document Understanding Bundle

Image

UiPathDocumentOCRaicenter/du-doc-ocr:v24.10-10.03-rc02
UiPathDocumentOCR_CPUaicenter/du-doc-ocr-cpu:v24.10-10.03-rc02
Extended Languages OCR

du/du-extended-ocr-proxy:v24.10-10.26-rc01

du/uipath-ocr-extended:v24.10-10.26-rc01

du/du-extended-ocr-reporting:v24.10-10.26-rc01

DocumentClassifieraicenter/du-ml-document-type-text-classifier:v24.10-10.03-rc02

Out-of-the-box Pre-trained ML Packages

aicenter/du-semistructured:v24.10-10.17-rc02

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.