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

OCR services

About 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.

Configure OCR service in Document Manager and AI Center Document Understanding™ ML packages

The table below shows how to configure the six supported OCR engine types in both Document Manager and AI Center.

Important: The 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

Google Cloud Vision OCR

GCP Console API Key

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

Microsoft Read 2.0 On-Prem

Microsoft Read OCR

None

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

Microsoft Read 2.0 Azure

Microsoft Read OCR

API Key for your resource from Azure Portal

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

Microsoft Read 3.2 On-Prem

Microsoft Read OCR

None

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

Microsoft Read 3.2 Azure

Microsoft Read OCR

API Key for your resource from Azure Portal

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

Note: *If you consume services or endpoints from an Automation CloudTM environment (for example, 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.

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.