document-understanding
latest
false
UiPath logo, featuring letters U and I in white

Document Understanding User Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Dec 12, 2024

One Click Classification

Use the One Click Classification feature to easily train document classifiers straight from the Document UnderstandingTM interface. This feature allows bypassing the need for manually creating Datasets, Pipelines, and ML Skills in AI Center with the help of a new user experience within Document Understanding.

Make sure that your Document Understanding project is linked to AI Center before using this functionality.

Classify option

You can use One Click Classification with Document Manager and/or Forms AI and can identify it by the Classify button.

To use One Click Classification, upload your documents in a Document Type session. Click on the New button and select one of the following options: Using Forms AI (fixed layout forms) or Using Semi-structured AI. Both options open a session where you can upload your documents. Once documents have been uploaded in their respective Document type session, you can use the New Classifier button to open the One Click Classification dialog.

The Classify button opens a dropdown with two options: Automated Training and Manual Training. Before using any of these options, make sure you have at least two Document Understanding sessions created with at least ten samples each. Not complying results in an error as the one below.



Automated training

Use the Automated Training option to train a classification dataset straight in Document Understanding. Once you choose this option, you have to add a Classifier Name, select the preferred Document Types, and select the version of the DocumentClassifier model. When finished, click the Train button.



This functionality automatically creates a new Dataset in AI Center with the name previously given by you in the Classifier Name field of the Train Classification dataset popup window.

Details

You can see more details about the created Automated Training action by clicking on the name of the classifier from the Classifiers page, or by clicking the actions menu, and selecting the Details option.

Here's a list with all the information provided by the Details option:

  • Training set - Specifies the number of documents and number of pages processed.
  • Documents classified - Specifies the number of classified documents.
  • F1 Score - Provides an accuracy score percentage for the dataset.
  • Status - Provides the status of the classification action.
  • Document types - Provides the list of Document types used for the action.
  • Package Name - Provides the name of the used ML Package.
  • Package Version - Provides the used version of the DocumentClassifier model.
  • ML Skill details - Provides the URL of the ML Skill created for the dataset. You can copy it and use it in your workflow.
  • Dataset link - Provides the public endpoint URL of the created (public) dataset.
  • Pipeline details - Provides the URL of the pipeline created for the dataset.
  • Score details - Specifies the accuracy score of the dataset.
  • View/Hide Logs - Provides a list with all the logs of the created dataset. You can copy it and use it when needed.
Note: Score details and Score percentage options are available for datasets running with DocumentClassifier version 23.1 or higher.

Manual training

Use the Manual Training option to export a classification dataset to AI Center and then train it in AI Center. Once you choose this option, you have to add a Dataset Name and select the preferred Document Types. When finished, click the Export button.



Details

You can see more details about the created Manual Training action by selecting the Classifiers tab from your project page, clicking on the actions menu, and selecting the Details option.

Here's a list with all the information provided by the Details option:

  • Training set - Specifies the number of documents and number of pages processed.
  • Documents classified - Specifies the number of classified documents.
  • F1 Score - Provides an accuracy score percentage for the dataset.
  • Status - Provides the status of the classification action.
  • Document types - Provides the list of Document types used for the action.
  • Package Name - Provides the name of the used ML Package.
  • Package Version - Provides the used version of the DocumentClassifier model.
  • ML Skill details - Provides the URL of the ML Skill created for the dataset. You can copy it and use it in your workflow.
  • Dataset link - Provides the public endpoint URL of the created (public) dataset.
  • Pipeline details - Provides the URL of the pipeline created for the dataset.
  • Score details - Specifies the accuracy score of the dataset.
  • View/Hide Logs - Provides a list with all the logs of the created dataset. You can copy it and use it when needed.

Classifiers status

You can check the status of all your classification actions by using the Classifiers tab from your project page.

Overview

Once the Classifiers tab is selected, you can see four different columns, each presenting information about the created classification actions. You can sort them individually in ascending or descending alphabetical order, or leave them in their default state, organized by creation date, with the latest on top:

  • Name - Displays the name of the classification actions.
  • Type - Displays the type of classification action (export or train).
  • Creation date - Displays the creation date.
  • Status - Displays the status of the action. There are multiple available statuses for each action. Check the table below for more details.
  • Refresh - Refreshes the statuses for all actions, displaying the most recent ones.

Status

Description

Classify Option

Available

The action was successfully executed.

Automated Training

InProgress

The action is still executed.

Automated Training

ExportCompleted

The action was successfully executed.

Manual Training

ExportInProgress

The action is still executed.

Manual Training

NotStarted

The execution of the action didn't start yet.

Automated Training

Manual Training

OutOfSync

The status from Document Understanding is not syncronized with the one from AI Center.

Automated Training

Manual Training

Suspended

The action was paused.

Automated Training

Manual Training

Actions menu

The actions menu is available on the right side and has the following options available, once opened:

  • Copy URL - Allows you to copy the URL of the public endpoint created with the Automated Training action.
  • Details - Provides information about the created action.
  • Delete - Deletes the created action from both Document Understanding and AI Center.
  • Stop ML Skill - Stops the ML Skill for the Automated Training action.
  • Classify option
  • Automated training
  • Manual training
  • Classifiers status
  • Overview
  • Actions menu

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.