- 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
- 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
- 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
- OCR services
- Deep Learning
- 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
OCR services
OCR services are used for the following purposes:
- At data labeling time, when importing documents into Document Manager. The engines available for this step are UiPath® Document OCR, Google Cloud Vision OCR, and Microsoft Read OCR.
- At run time when calling models from RPA workflows. The engines available for this step are all the engines integrated with the UiPath RPA platform including the above, plus Microsoft OCR (legacy), Microsoft Project Oxford OCR, and Tesseract.
In production, we recommend calling the OCR using the Digitize Document activity in your workflow and passing the Document Object Model as input to the activity calling the ML model. For this purpose, you need to use the Machine Learning Extractor activity (Official feed).
As a quick convenience for testing purposes, you can also configure the OCR directly in AI Center (Settings window), but this is not recommended for production deployments.
The table below shows how to configure the six supported OCR engine types in both Document Manager and AI Center.
ocr.method
argument corresponds to the OCR Engine dropdown in the ML Package creation view in AI Center.
OCR Engine |
OCR Method |
OCR Key |
OCR URL |
---|---|---|---|
UiPath |
UiPath Document OCR (Cloud and On-Premises) UiPathDocumentOCR_CPU(On-Premises) OCR for Chinese, Japanese, Korean (Cloud and On-Premises) |
Automation Suite API Key* Enterprise Plan | The ML Skill URL generated after deploying UiPath Document OCR. |
|
Google Cloud Vision OCR |
GCP Console API Key |
|
Microsoft Read 2.0 On-Prem |
Microsoft Read OCR |
None |
|
Microsoft Read 2.0 Azure |
Microsoft Read OCR |
API Key for your resource from Azure Portal |
|
Microsoft Read 3.2 On-Prem |
Microsoft Read OCR |
None |
|
Microsoft Read 3.2 Azure |
Microsoft Read OCR |
API Key for your resource from Azure Portal |
|
du.uipath.com/ocr
or du.uipath.com/ie/invoices
)
while you are using a deployment type other than Automation Cloud, such as Automation
Suite offline, you need to add the API key from an Automation Cloud account. Make sure
that you use the Automation Cloud API Key for public endpoints, and the Automation Suite
API Key for endpoints hosted within Automation Suite.