- 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
- 1040 Schedule C - ML package
- 1040 Schedule D - ML package
- 1040 Schedule E - 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
- UB04 - 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
- Deep Learning
- Document Understanding deployed in Automation Suite
- Install and use
- First run experience
- Deploy UiPathDocumentOCR
- Deploy an out-of-the-box ML package
- Offline bundles 2023.10.12+patch1
- Offline bundles 2023.10.12
- Offline bundles 2023.10.11
- Offline bundles 2023.10.10
- Offline bundles 2023.10.9
- Offline bundles 2023.10.8
- Offline bundles 2023.10.7+patch1
- Offline bundles 2023.10.7
- Offline bundles 2023.10.6
- Offline bundles 2023.10.5
- Offline bundles 2023.10.4
- Offline bundles 2023.10.3
- Offline bundles 2023.10.2
- Offline bundles 2023.10.1
- Offline bundles 2023.10.0
- Use Document Manager
- Use the Framework
- Document Understanding deployed in AI Center standalone
- Licensing
- API Key
- Cloud and on-premises usage
- Metering and charging logic (Flex Plan)
- Legal information
- 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
Cloud and on-premises usage
The activities from this page can be executed by any Robot, be it connected to a Cloud or on-premises Orchestrator. For Enterprise scenarios, they need access to the environment the Document UnderstandingTM licenses are stored in. These can appear either in a cloud account or in an on-premises Orchestrator.
The configuration of these activities differs based on your setup. Please choose the scenario you are based on, considering the type of license you have and where your Document Understanding bundles reside (cloud or on-premises).
If you consume services or endpoints from an Automation Cloud™ environment (for example, du.uipath.com/ocr or du.uipath.com/ie/invoices) while you are using a different deployment type, such as Automation Suite offline, you need to add the API key from an Automation Cloud account, not the one available in Automation Suite..
Form Extractor / Intelligent Keyword Classifier
| Scenario | URL | API Key | Limitations | Track your consumption |
|---|---|---|---|---|
| Community Cloud | The default endpoint pre-populated in the activity. | In Automation Cloud™, the API Key you find under Consumables for AI Units. | Documents of maximum 2 pages. Maximum 50 requests per hour. | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise Cloud | The default endpoint pre-populated in the activity. | In Automation Cloud™, the API Key you find under Consumables for AI Units. | N/A | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise on-premises deployed on AI Center standalone | The public endpoint for the ML Skill published in your local AI Center instance. | In Automation Cloud™, the API Key you find under Consumables for AI Units. | N/A | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise on-premises air-gapped (offline) deployed on AI Center standalone | The public endpoint for the ML Skill published in your local AI Center instance. | N/A 1 | N/A | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise on-premises deployed on Automation Suite | The public endpoint for the ML Skill published in your local AI Center instance. | In Automation Suite, the API Key you find under Robots & Services for AI Units. | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
| Enterprise on-premises air-gapped (offline) deployed on Automation Suite | The public endpoint for the ML Skill published in your local AI Center instance. | In Automation Suite, the API Key you find under Robots & Services for AI Units. | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
1 There is no API Key needed in case of an AI Center standalone offline deployment. However, you need to type in a string of characters instead of the API Key.
You can use the API Key under Document Understanding pages if the license contains Document Understanding pages instead of AI units
When using an on-premises air-gapped ML Skill deployed on AI Center standalone with the Form Extractor / Intelligent Keyword Classifier activity, the robot needs to be connected to the Orchestrator tenant where the skill was created.
Machine Learning Classifier
| Scenario | URL/ML Skill | API Key | Limitations | Track your consumption |
|---|---|---|---|---|
| Community Cloud1 | Public ML Skill endpoint from AI Center / ML Skill | In Automation Cloud™, the API Key you find under Consumables for AI Units. | Documents of maximum 2 pages. Maximum 50 requests per hour. | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise Cloud | Public ML Skill endpoint from AI Center / ML Skill | In Automation Cloud™, the API Key you find under Consumables for AI Units. | N/A | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise on-premises deployed on AI Center standalone | Public ML Skill endpoint from AI Center / ML Skill | In Automation Cloud™, the API Key you find under Consumables for AI Units. | N/A | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise on-premises air-gapped (offline) deployed on AI Center standalone | Public ML Skill endpoint from AI Center / ML Skill | N/A 2 | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
| Enterprise on-premises deployed on Automation Suite | Public ML Skill endpoint from AI Center / ML Skill | In Automation Suite, the API Key you find under Robots & Services for AI Units. | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
| Enterprise on-premises air-gapped deployed on Automation Suite | Public ML Skill endpoint from AI Center / ML Skill | In Automation Suite, the API Key you find under Robots & Services for AI Units. | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
1 Machine Learning Classifier works with Document Understanding Community license, but you need access to AI Center for model training and hosting.
2 There is no API Key needed in case of an AI Center standalone offline deployment. However, you need to type in a string of characters instead of the API Key.
Machine Learning Extractor
| Scenario | URL/ML Skill | API Key | Limitations | Track your consumption |
|---|---|---|---|---|
| Community Cloud | Public Document Understanding Endpoints | In Automation Cloud™, the API Key you find under Consumables for AI Units. | Documents of maximum 2 pages. Maximum 50 requests per hour. | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise Cloud | Public Document Understanding Endpoints or AI Center hosted custom ML Skill (Public ML Skill endpoint from AI Center / ML Skill) | In Automation Cloud™, the API Key you find under Consumables for AI Units. | Documents of maximum 30 pages, only if you are using public Document Understanding endpoints. | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise on-premises deployed on AI Center standalone | Public ML Skill endpoint from AI Center / ML Skill | In Automation Cloud™, the API Key you find under Consumables for AI Units. | N/A | Home > Admin > Licenses > Consumables > AI Units |
| Enterprise on-premises air-gapped (offline) deployed on AI Center standalone | No URL, select ML Skill instead | N/A 1 | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
| Enterprise on-premises deployed on Automation Suite | Public ML Skill endpoint from AI Center / ML Skill | In Automation Suite, the API Key you find under Robots & Services for AI Units. | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
| Enterprise on-premises air-gapped deployed on Automation Suite | Public ML Skill endpoint from AI Center / ML Skill | In Automation Suite, the API Key you find under Robots & Services for AI Units. | N/A | Home > Admin > Licenses > Robots & Services > AI Units |
1 There is no API Key needed in case of an AI Center standalone offline deployment. However, you need to type in a string of characters instead of the API Key.