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 Extraction

Use the One Click Extraction feature to easily train document extractors 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.

Extractors option

You can use One Click Extraction functionality to create a new extractor based on an existing semi-structured AI document type by clicking the New Extractor button.

The New Extractor button opens a drop-down with two options: Automated Training and Manual Training.

Automated training

Use the Automated Training option for training an extractor straight in Document Understanding. Once you choose this option, you have to add an Extractor Name, select the preferred Document Type, select the Model that you want to use, and its version, enable or disable the Use GPU option and select the version of the model. When finished, click on the Train button.

Note:

Keep in mind that before starting training an extractor, you need to have at least ten documents labelled in the session that you are planning on using.

docs image

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

Note: To update an extractor after labeling additional data, you need to create a new extractor under a distinct name.

Details

You can see more details about the created Automated Training action by clicking on the name of the extractor from the Extractors page, or by 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.
  • Pages Extracted - Specifies the number of extracted pages.
  • F1 Score - Provides an accuracy score percentage for the dataset.
  • Status - Provides the status of the extraction 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 version of the used ML Package 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.
  • View/Hide Logs - Provides a list with all the logs of the created dataset. You can copy it and use it when needed.

Manual training

Use the Manual Training option to export a 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 Type. When finished, click on the Export button.

docs image
Note: To update an extractor after labeling additional data, you need to create a new extractor under a distinct name.

Details

You can see more details about the created Manual Training action by clicking on the name of the extractor from the Extractors page, or by 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.
  • Pages Extracted - Specifies the number of extracted pages.
  • F1 Score - Provides an accuracy score percentage for the dataset.
  • Status - Provides the status of the extraction 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 version of the used ML Package 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.
  • View/Hide Logs - Provides a list with all the logs of the created dataset. You can copy it and use it when needed.

Extractors status

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

Overview

Once the Extractors tab is selected, you can see five 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).
  • Document Type - Displays the used Document type.
  • Status - Displays the status of the action. There are multiple available statuses for each action. Check the table below for more details.
  • Creation date - Displays the creation date.
  • 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. Navigate to AI Center and check the status of the ML Skill corresponding to the extractor you have created. If the ML Skill has become undeployed, deploy it again.

Automated Training

Manual Training

Suspended

The action was paused.

Automated Training

Manual Training

Actions menu

The action 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.
  • Extractors option
  • Automated training
  • Manual training
  • Extractors 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.