document-understanding
2022.10
false
Document Understanding User Guide
- Overview
- Document Understanding Process
- Quickstart Tutorials
- Framework Components
- ML Packages
- Pipelines
- Document Manager
- OCR Services
- OCR Services
- Document Understanding deployed in Automation Suite
- Install and use
- First run experience
- Deploy UiPathDocumentOCR
- Deploy an out-of-the-box ML package
- Offline Bundles 2022.10.0
- Offline Bundles 2022.10.2
- Offline Bundles 2022.10.4
- Offline Bundles 2022.10.6
- Offline Bundles 2022.10.8
- Offline bundles 2022.10.9
- Offline Bundles 2022.10.10
- Offline bundles 2022.10.11
- Offline bundles 2022.10.12
- Offline bundles 2022.10.13
- Offline bundles 2022.10.14
- Offline bundles 2022.10.14+patch1
- Offline bundles 2022.10.15
- Use Document Manager
- Use the Framework
- Document Understanding deployed in AI Center standalone
- Deep Learning
- Licensing
- References
- UiPath.Abbyy.Activities
- UiPath.AbbyyEmbedded.Activities
- UiPath.DocumentUnderstanding.ML.Activities
- UiPath.DocumentUnderstanding.OCR.LocalServer.Activities
- UiPath.IntelligentOCR.Activities
- UiPath.OCR.Activities
- UiPath.OCR.Contracts
- UiPath.DocumentProcessing.Contracts
- UiPath.OmniPage.Activities
- UiPath.PDF.Activities
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 Abbyy Finereader, 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.
Configuring 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 | UiPath Automation Cloud Document Understanding API Key Enterprise Plan | http://<IP_addr>:<port_number> |
| 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 |