Document Understanding user guide

Getting started​

• For models 2022.10 and newer:
  • Download the needed Document Understanding^TM 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-2024.10.0.tar.gz contains information about all out-of-the-box pre-trained ML Packages included in the 2024.10.0 version.
• For models 2022.4 and older (python37duv3 and python37duv4):
  • All ML Packages are provided as a .zip file 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.

Install the offline bundle​

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 using the following command:

   assignment

   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:

   assignment

   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):

   assignment

   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:

   assignment

   ./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​

Form Extractor and Intelligent Keyword Classifier​

• <FQDN>/du_/svc/formextractor
• <FQDN>/du_/svc/intelligentkeywords

Upload a Document Understanding™ bundle to an 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​

docker pull <uipath_registry_server>/<image_name>
docker pull <uipath_registry_server>/<image_name>

docker pull registry.uipath.com/aicenter/du-doc-ocr:v24.10-10.3-rc02
docker pull registry.uipath.com/aicenter/du-doc-ocr:v24.10-10.3-rc02

Rename the image host​

docker tag <uipath_registry_server>/<image_name> <your_registry_server>/<image_name>
docker tag <uipath_registry_server>/<image_name> <your_registry_server>/<image_name>

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

docker push <your_registry_server>/<image_name>
docker push <your_registry_server>/<image_name>

docker push registory.mycompany.com/aicenter/du-doc-ocr:v24.10.0
docker push registory.mycompany.com/aicenter/du-doc-ocr:v24.10.0

Images for each Document Understanding bundle​

2024.10.8​

2024.10.7​

2024.10.6​

2024.10.5​

2024.10.4​

2024.10.3​

2024.10.2​

2024.10.1​

2024.10.0​