document-understanding
latest
false
Document Understanding User Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 1, 2024

Cloud and on-premises usage

The activities below 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).

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.

Note:

You can use the API Key under Document Understanding pages if the license contains Document Understanding pages instead of AI units

Note: 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.

Important: Currently, no warnings are sent out when you are close to the Document Understanding consumption limit, so please check your consumption status periodically. If you run out of Document Understanding AI units, your activity will stop running.

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.