Subscribe

UiPath AI Fabric

UiPath AI Fabric

OCR Engines

🚧

Important!

Before proceeding, make sure to check the following first, and make sure you meet the requirements and installed the prerequisites:
Hardware Requirements
Prerequisites for Installation

UiPath OCR (Preview)

  1. Run these commands:
docker login aiflprodweacr.azurecr.io -u *** -p **
docker pull aiflprodweacr.azurecr.io/uipath-ocr:latest
  1. Run using CPUs
docker run -d -p 5000:80 aiflprodweacr.azurecr.io/uipath-ocr:latest LicenseAgreement=accept
  1. Run using GPU
docker run -d -p 5000:80 --gpus all aiflprodweacr.azurecr.io/uipath-ocr:latest LicenseAgreement=accept
  1. In AI Fabric, when creating a new ML Package, at the bottom of the screen there is the OCR configuration section where you can define the OCR Engine type, the OCR URL and the OCR Key. The OCR Key is the API Key you obtain from the Licenses section of your Automation Cloud account.

Running on the Same Machine as AI Fabric v2020.4

🚧

Running on the same machine as AI Fabric v2020.7

UiPath Document OCR container and Omnipage OCR container cannot run on the same machine as AI Fabric on premises v2020.7 or later.

UiPath OCR can run on the same machine as AI Fabric v2020.4 but only using CPU, and you need to make sure the memory usage is limited such that AI Fabric v2020.4 still has its minimal required RAM available.

  • For instance, to limit UiPath OCR to only use 4GB of RAM you can use this command:
docker run -d -p 5000:80 –m 4g aiflprodweacr.azurecr.io/uipath-ocr:latest LicenseAgreement=accept
  • When running on CPU, UiPath OCR requires at least 2GB of RAM, but for best performance we recommend 4GB of RAM. Performance does not improve noticeably with over 8G of RAM.

OmniPage OCR

The Omnipage docker container is intended to be used only with Data Manager, for importing documents in languages which UiPath Document OCR does not yet support.

  1. Run these commands:
docker login aiflprodweacr.azurecr.io -u *** -p ***
docker pull aiflprodweacr.azurecr.io/omnipage-ocr:latest
docker run -d -p 5100:80 aiflprodweacr.azurecr.io/omnipage-ocr:latest LicenseAgreement=accept

Google Cloud OCR

The endpoint can be obtained from the Google Cloud Platform documentation. The ApiKey can be obtained from your Google Cloud Platform Console, if you have a Google Cloud Vision service in your subscription.

Microsoft Read

Applicable to both Azure and on-premises container endpoints.
In the case of Azure services you need to provide both the Endpoint and the ApiKey. In the case of on-premises container endpoints, API Key is not necessary.

Configuring OCR service in Data Manager and AI Fabric Document Understanding ML Skills

The table below shows how to configure the 5 supported OCR engine types in both Data Manager and AI Fabric.
The ocr.method argument corresponds to the OCR Engine dropdown in the ML Package creation view in AI Fabric.

OCR Engine

ocr.method

ocr.key

ocr.url

UiPath

uipath

UiPath Automation Cloud
Document Understanding API Key
Enterprise Plan

http://<IP_addr>:<port_number>

OmniPage

omnipage

UiPath Automation Cloud
Document Understanding API Key
Enterprise Plan

http://<IP_addr>:<port_number>

Google

google

GCP Console API Key

https://vision.googleapis.com/v1/images:annotate

Microsoft Read 2.0 On-Prem

microsoft

None

http://<IP_addr>:<port_number>/vision/v2.0/read/core/Analyze

Microsoft Read 2.0 Azure

microsoft

API Key for your resource from Azure Portal

<Azure_resource_Endpoint>/vision/v2.0/read/core/asyncBatchAnalyze

Microsoft Read 3.1 On-Prem

microsoft

None

http://<IP_addr>:<port_number>/vision/v3.1/read/analyze

Microsoft Read 3.1 Azure

microsoft

API Key for your resource from Azure Portal

<Azure_resource_Endpoint>/vision/v3.1/read/analyze

Updated 2 months ago


OCR Engines


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.