How to get detailed information on the usage of AI units that are consumed through Document Understanding and AI Center?
Document Understanding and AI Center Consumption Dashboards
Overview
Based on the actions performed in Document Understanding and AI Center, the AI units consumption dashboards provide a detailed view of AI unit consumption at the tenant level. Detailed information about AI unit consumption is now accessible through the AI Units consumption overview and Document Understanding and AI Center consumption Dashboard included in Insights.
Table of contents
- List of pre-requisites for Automation Cloud and Automation Suite
- Enabling Insights and AI Units Consumption Dashboard on the Tenant
- Type of dashboards and Consumption Details
- Limitations
- Data Retention
List of Pre-requisites for Automation Cloud and Automation Suite
Prerequisites for Automation Cloud
- Automation Cloud Enterprise customers use Insights for free to view this dashboard.
- To access the Document Understanding and AI Center AI units consumption dashboard, Insights must be enabled on your tenant.
Prerequisites for Automation Suite
- Starting from Automation Suite v24.10 and onward, AI units consumption overview and Document Understanding and AI Center consumption Insights dashboards are available for use.
- To access the AI units consumption overview dashboard, you must purchase Insights, install the component and enable it for your tenant.
- To find out how to install Insights in Automation Suite, check out the Automation Suite on Linux Installation Guide.
Studio and Activities Versions for Optimal Results
For optimal results, make sure you are using these minimum versions or higher:
• UiPath Studio and Robot: 2023.10
• UiPath.DocumentUnderstanding.Activities package: 2.9.1
• UiPath.DocumentUnderstanding.ML.Activities package: 1.28.2
• UiPath.IntelligentOCR.Activities package: 6.19.1
• UiPath.MLServices.Activities: 2.0.2
Enabling Insights and AI Units Consumption Dashboard on the Tenant
Enabling Insights
Access is granted at the tenant level. A user with administrator permissions on Automation Cloud can enable Insights for a tenant via the following steps:
- Navigate to your respective Automation Cloud URL and log in with your UiPath account.
- From the left navigation pane, select the 'Admin' option.
- Under the 'Tenants' context menu, find the tenant you want to enable Insights for, and click 'Services'.
- Select the 3-dotted menu from Insights and click 'Enable'.
- A confirmation message is displayed and from the left navigation menu, you should be able to select 'Insights' within 1-2 minutes.
Enabling the Dashboard on the Tenant
In order to use the dashboard, you need to enable Insights on your tenant:
-
Go to the three-dot menu ⋮ on the top right corner of the screen and select 'Tenant Profile'.
- Select the Insights Dashboard URL toggle button to enable Insights.
Type of dashboards and Consumption Details
There are two types of AI Units consumption dashboards:
1.AI Units Consumption Overview provides Organization-Level Consumption Overview (number of AI units consumed by each tenant ) and Tenant-Level Consumption Overview (usage pattern of AI units specific to an individual tenant)
2. Document Understanding and AI Center Consumption Dashboard – Offers a detailed view of AI units consumption at the tenant level, categorized by project, model, skills, etc.
Note: For Document Understanding, the data in the dashboard covers both cross-platform DocumentUnderstanding.Activities and IntelligentOCR.Activities, applicable for both classic and modern projects, as well as consumption occurring by using API calls. Data is reported for pre-trained specialized and generative models, as well as custom models.
You can find them under Insights--> 'UiPath Templates'
1. Consumption by Project Chart
Consumed AI units, grouped by Document Understanding or AI Center project. The information is displayed in the form of a line chart. Displays the consumption of the top 10 highest-consuming projects. For all projects, check out the table.
2. Consumption by Project Table
Consumed AI units, grouped by Document Understanding or AI Center project. The information is displayed in the form of a table with additional information:
- Project Name: name of the Document Understanding or AI Center project used for consuming AI units.
- Project Id: ID of the Document Understanding or AI Center project used for consuming AI.
- Project type: type of the project used for consuming AI units:
- Document Understanding modern project
- Document Understanding classic project
- AI Center
- N/A - this is displayed for IntelligentOCR workflows that do not reference a Document Understanding project.
- AI units: total number of AI units consumed in the project.
- Pages: total number of pages processed in the project ("N/A" is shown when consumption does not occur for a certain number of pages, e.g., AI Center infrastructure or training costs).
3. Consumption by Operation
Consumed AI units, grouped by Document Understanding or AI Center project and operation:
- Project Name: name of the Document Understanding or AI Center project where the operation was run.
- Project Id: ID of the Document Understanding or AI Center project where the operation was run.
- Operation name: name of the operation used for consuming AI units (for example, model name, digitization, Intelligent Keyword Classifier, and so on).
- Automation name: name of the automation used for consuming AI units.
Note: If the value is displayed as Unknown, it means that there is no related data. This could result from using an outdated Robot or activity package version, or if API Keys were used to access public endpoints, such as
du.uipath.com/invoices.The value is displayed as Unknown also in the case of suspended jobs. In this case, the entry is populated after the job resumes and the automation execution finishes.
- AI units: total number of AI units consumed by the operation.
- Pages: total number of pages processed by the automation.
4. Consumption by AI Center Operation Chart
Consumed AI units corresponding to AI Center operations:
- Runtime consumption referring to predictions using AI Center models (excluding Document Understanding).
- Training consumption for training the model.
- Hosting for serving the model.
5. Consumption by AI Center Resources Table
Consumed AI units corresponding to the used AI Center resources, including the operation performed. The information is displayed in the form of a table with additional information:
- Project Name: name of the AI Center project where the operation was run.
- Source: this can be one of the following:
- Name of the ML Skill used for hosting.
- Name of the ML package used for training. When consumption if made from the AI Center training infra, the
packageVersionis displayed between square brackets. - Name of the ML Skill used for runtime.
- Type: the type of the operation used for consuming AI units:
- Runtime
- Training
- Hosting
- AI units: total number of AI units consumed by the resource.
Limitations
- The dashboards only display consumption information starting the 1st of July.
- Data is refreshed every 24 hours (Therefore, the numbers in the dashboard may differ from the total in the Consumables tab, which can be found under Admin > Licenses > Consumables > AI Units.)
- The dashboard displays all data from a tenant and from the region the tenant is available in.
- Consumption occurring at the organization level (such as when using API Keys as the authentication method configured at the organization level) is not displayed in the tenant-level dashboards.
- The dashboards only display consumption AI Units that have been consumed using Document Understanding & AI Center - other services to be onboarded soon (Task Mining, Process Mining, Communications Mining).
- AI units consumed by the AI Center ML skills, based on out of the box packages that are older than version 22.10, are not displayed in the dashboard. Only the AI units consumed for infrastructure are displayed. AI units used for calling skills are not tracked and therefore are not displayed in the dashboard. Note that upgrading the ML packages version also implies retraining for retrainable models.
- If the value for Automation Name is displayed as Unknown, it means that there is no related data. This could result from
- using an older Robot or activity package version which is not reporting the needed data,
- if the data resides in a different region
- Using API Keys as the authentication method
Make sure you update your Robot and activity packages to the recommended versions, so that the dashboard can collect all required data points.
Data Retention
- For Automation Cloud - check the Data retention policy section.
- For Automation Suite - by default, there is no data retention for Automation Suite deployments.