Document Understanding
latest
false
Banner background image
Document Understanding User Guide
Last updated 13 de mai de 2024

Introduction

Document Understanding is the main starting point for creating new projects. You can use it for structured or semi-structured documents, and also along with pre-trained models. You can always start a training session from scratch, validate your documents, and customize the projects as needed.

Overview Page

Here you can find a list of all the created projects, with specific details. You can sort the projects alphabetically, or by date, create a new project, and customize the page view.

Projects

Presents the list of all created projects. There are three types of sorting for Projects:

  • Alphabetically in ascending order
  • Alphabetically in descending order
  • By creation date.

    The default sorting order is by the creation date.

Once a project is created you can select the type of the document. There are two options:

  • Using Forms AI (fixed layout format) - intended for Forms AI
  • Using Semi-Structured AI - intended for Document Manager


If you want to delete a document type, then open your project, select the document type that you want to delete, open the Action Menu and click on the Delete option.

Columns

Use this function to customize the amount of details available for the Projects list. Here's the full list of details that can be displayed for each created project.

  • Name - Displays the name of the project.
  • Document types - Displays the type of documents used for each project.
  • Extractors - Displays the number of extractors used for each project.
  • Documents processed - Displays the number of processed documents for each project.
  • Creation Date - Displays the creation date for each project.
  • Refresh - Refreshes the information in the displayed columns for all projects.
Tip: You can select which column are displayed from the Columns ˅ drop-down menu. If you click Reset, all fields will be displayed, no matter of the previous selections.

New Project

Create a new project by using the New project button. Clicking on the New project opens a new popup window.

When a new project is created, the following information is required:

Option

Description

Field status

Name

Provide a name for the new project.

Mandatory

Description

Provide more details about the project.

Optional

OCR method

Select the OCR method for the new project.

Choose between the following options:

  • UiPath Document OCR
  • UiPath Chinese, Japanese, Korean OCR
  • Google Cloud Vision OCR
  • Google Cloud Vision for Japanese
  • Microsoft Read OCR

Mandatory

OCR URL

Provide the OCR URL corresponding to the chosen OCR method.

Here's the list of the OCR URLs corresponding to the UiPath OCR method.

Here is a list of other commonly used OCR URLs:

Microsoft Read 3.2 Azure: <Azure_resource_Endpoint>/vision/v3.2/read/analyze
Microsoft Read 3.2 On-Prem: http://<IP_addr>:<port_number>/vision/v3.2/read/analyze
Microsoft Read 2.0 Azure: <Azure_resource_Endpoint>/vision/v2.0/read/core/asyncBatchAnalyze
Microsoft Read 2.0 On-Prem: http://<IP_addr>:<port_number>/vision/v2.0/read/core/Analyze

Mandatory

OCR API Key

Provide the OCR API Key for the chosen OCR method.

If the OCR method is UiPath OCR, or UiPath Chinese, Japanese, Korean OCR, then the value of this field is available on the cloud platform by going to Home > Admin > Licenses > Consumables > AI Units

Optional

Apply OCR on PDF

Establishes if the OCR process should be applied or not to PDF documents. If set to Yes, the OCR is applied to all PDF pages of the document.

If set to No, the OCR is not applied to any pages and returns only the text embedded in the PDF . When set to Auto OCR applies only to the scanned pages of the document. The default value is Auto.

Mandatory

AI Center Project

Provide the name of the AI Center project that you want to import.

Optional

Import from AI Center

Enables/disables the import function from AI Center

Optional

Here's how a project can be imported from AI Center.



Note: UiPath OCR API Key is also available on the cloud platform by going to Admin/Licenses/Robots & Services/Document Understanding and copying the available key.

A project linked to AI Center is easily identified by the AI Center icon, like in the below image.



If you want to delete a project that's linked to AI Center, then the deleting procedure automatically deletes it from AI Center as well.



Project Page

Here you can find more in depth details about the created project, edit the name of the project, or create a new document type.

The first row of information presents the following details:

  • Project name - The name of the project.
  • Date - Details about the project time creation.
  • Settings - Opens the popup menu from the Overview page. More details about it can be found here.

Document Types and Extractors

Below the general details, you can find two tabs:

Document type - Provides a list of all the available document types for the selected project. Defining a document type is mandatory for creating an extractor or classifier. A document type can be an invoice, a purchase order, or a standardized form.

Document types menu

Description

Name

Presents the name list of all created document types.

Extraction method

Presents the used type of extraction method for the selected document type.

Pages

Presents the total number of pages found in each document type.

Refresh

Refreshes the list of projects.

Extractors - Provides the list of extractors created for the document types of the selected project. Use extractors to train the document types.

Extractors types menu

Description

Name

Presents the name list of all extractors from the created document types.

Type

Presents the type of used extractor.

Creation date

Presents the creation date for each extractor.

Pages processed

Presents the number of processed pages by each extractor.

Status

Presents the status of each extractor.

Refresh

Refreshes the list of extractors.

Extractor's menu

Offers the possibility to copy the Extractor's URL link.

Both Document types and Extractors have three types of sorting the information:

  • Alphabetically in ascending order.
  • Alphabetically in descending order.
  • By creation date.

    The default sorting order is by the creation date.

    Note: Document types are mandatory in a project, while extractors are optional. You can choose to add an extractor for any of the document types.

Other Options

The following options are applicable throughout the entire interface of Document Understanding.

Search option enables you to initiate a search among the available list of projects, document types, or extractors. Search is active separately for each selected tab, meaning that if you want to search for an extractor, you should select the Extractors tab. Same applies for Document types. Start a search by typing the name of the project inside the Search bar.

Refresh - Refreshes the list of projects.

Remove project - Deletes the selected project. The Remove project button becomes visible only after opening the action menu.

Note: When deleting a project, all containing document types and extractors are deleted along with the project.

Page scrolling - Easy scroll through the list of project pages, document types, or extractors. Go page by page or skip directly to the first/last page.

Items per page - Select the number of projects, document types, or extractors displayed per project page.

REST API - Opens the REST API framework capabilities.

Licensing

In the Licensing category of this guide, you can check the following information:

RPA Integration

If you want to integrate your Document Understanding project into an RPA workflow, make sure that you follow the steps below:

  • Open UiPath Studio and create a new project by selecting Document Understanding Process from the templates list.

The following packages should also be added to your UiPath Studio project:

  • UiPath.IntelligentOCR.Activities
  • UiPath.OCR.Activities
  • UiPath.DocumentUnderstanding.OCR.LocalServer
  • UiPath.DocumentUnderstanding.ML.Activities
  • UiPath.Omnipage.Activities

Make sure Document Understanding is enabled on your tenant.



Once the Document Understanding is enabled, the Document Understanding tab appears on the left navigation bar.



  • Overview Page
  • Projects
  • Columns
  • New Project
  • Project Page
  • Document Types and Extractors
  • Other Options
  • Licensing
  • RPA Integration

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.