UiPath Documentation
document-understanding
2020.10
false
Document Understanding User Guide

Cloud & On-Prem Usage

The activities below can be executed by any Robot, be it connected to a Cloud or On-Prem Orchestrator. For Enterprise scenarios, they need access to the environment the Document Understanding licenses are stored in. These can appear either in a Cloud account or in an On-Prem 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 Understandsting bundles reside (Cloud or On-Prem).

Intelligent Keyword Classifier / Form Extractor / Intelligent Form Extractor

ScenarioURLAPI KeyLimitationsTrack your consumption
Community CloudThe default endpoint pre-populated in the activity.The API Key you find under Licenses for Document Understanding.Documents of maximum 2 pages.

Maximum 50 requests per hour.
N/A
Enterprise CloudThe default endpoint pre-populated in the activity edited by adding /?edition=enterprise to the end of the string.The API Key you find under Licenses for Document Understanding.N/AHome > License Usage > Other Services > Document Understanding
Enterprise On-PremThe public endpoint for the Form Extractor skill published in your local AI Fabric instance.The API Key you find under Licenses for Document Understanding.N/AHome > License Usage > Other Services > Document Understanding (requires Cloud account)
Enterprise On-Prem Air-Gapped (Offline)The public endpoint for the Form Extractor skill published in your local AI Fabric instance.N/AN/ATenant > License tab > UiPath Document Understanding card
Note:

When using an On-Prem Air-Gapped ML Skill with the Intelligent Keyword Classifier / Form Extractor / Intelligent Form Extractor activity, the robot needs to be connected to the Orchestrator tenant where the skill was created.

Machine Learning Extractor

Scenario Supported Supported Robot Connections URL API Key Limitations Track your Consumption
  • Account Type: Community
  • DU Licensing: N/A
  • Using: Public DU Endpoints

docs image

  • No Orchestrator
  • On-Prem
  • Cloud

Any endpoint from the following list.

The API Key you find under Licenses for Document Understanding.

Documents of maximum 2 pages.

Maximum 50 requests per hour.

N/A

  • Account Type: Enterprise
  • DU Licensing: Cloud
  • Using: Public DU Endpoints

docs image

  • No Orchestrator
  • On-Prem
  • Cloud

Any endpoint from the following list.

The API Key you find under Licenses for Document Understanding.

Documents of maximum 30 pages.

Home > License Usage > Other Services > Document Understanding (requires Cloud account)

  • Account Type: Enterprise
  • DU Licensing: On-Prem

    -Using: Public DU Endpoints

docs image

     
  • Account Type: Community
  • DU Licensing: N/A
  • Using: AI Fabric hosted custom DU ML Skills

docs image

     
  • Account Type: Enterprise
  • DU Licensing: Cloud
  • Using: AI Fabric hosted custom DU ML Skills

docs image

Cloud

No URL, ML Skill selected instead.

The API Key you find under Licenses for Document Understanding.

N/A

Home > License Usage > Other Services > Document Understanding (requires Cloud account)

  • Account Type: Enterprise
  • DU Licensing: On-Prem
  • Using: AI Fabric hosted custom DU ML Skills

docs image

On-Prem

No URL, ML Skill selected instead.

N/A

N/A

Home > License Usage > Other Services > Document Understanding

  • Account Type: Community
  • DU Licensing: N/A
  • Using: AI Fabric hosted custom DU Models through URLs

docs image

     
  • Account Type: Enterprise
  • DU Licensing: Cloud
  • Using: AI Fabric hosted custom DU Models through URLs

docs image

     
  • Account Type: Enterprise
  • DU Licensing: On-Prem
  • Using: AI Fabric hosted custom DU Models through URLs

docs image

     
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 units, your activity will stop running.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated