Document Understanding classic user guide

The Taxonomy Manager can be used to create and edit a Taxonomy file specific to your current automation project. This Taxonomy file contains user-defined document types, organized in Groups and Categories.

You can further use the Taxonomy file by converting it into a.NET data type with the Load Taxonomy activity, and then passing it as input for activities such as:

只有在安装 v1.6.0 或更高版的 UiPath.IntelligentOCR.Activities 包作为项目依赖项后，才能访问分类管理器。包安装完成后，“向导”部分的功能区中会显示“分类管理器”按钮。

“分类管理器”窗口用于创建按组和类别组织的文档类型。首次在项目中打开“分类管理器”时，系统不会定义任何组、类别或文档类型。

Figure 1. The Taxonomy Manager before mapping any document types or fields

第一步是创建组或文档类型。两者之间的区别在于，组涉及层次结构，而文档类型可以创建为单个文件。复杂的项目意味着创建组、类别和文档类型，而简单的项目只能要求创建一种或两种文档类型。

When a group is created, a category is also necessary for the document type you want to create inside the group. This is done by using the Group button. Once you have chosen a name for your group, you can save it by using the Save button or by using the Enter key.

Once a group is defined and selected, you can create a Category and/or a Document Type within the group, by using their defined buttons. Select Save or use the Enter key to save the configuration.

A Document Type can be created either as part of a group or as a single document. When created inside a group, make sure that the group is selected, then select Document Type.

If the Document Type is created as a single file, make sure that no group is selected and select Document Type. After selecting Document Type, enter a name for the file and select Save.

Selecting an already created Document Type lets you change its name, copy its unique ID to clipboard, or reassign it to another group or category. You can also input a code for the document type.

Once a document type is saved, a Document Type ID is generated for it. Opening the document for editing displays the ID next to the Document Type Name tab. The Document Type ID has a structure of the type Group.Category.Document and can be copied to the clipboard. The Document Type ID code is an optional functionality and it can be used to find your documents or map your documents to the Document Types that you define in the taxonomy.

After you create the document type, you can configure its display settings. Select the document type in the Taxonomy Manager, and go to Display settings. You can change the following configurations:

When the Document Type is selected, the Field button becomes available to create a new field. Once the Field button is selected, you can enter a name for it and select its type from the dropdown list.

The Field category has two tabs: Details and Rules. The Details tab provides information about the selected field, such as Field Name, assigned hotkey, or field type, while the Rules tab allows you to create rules that need to be fulfilled by the extraction result for the field.

提供以下字段类型：

详细信息选项卡

After the new Field is created, select it to view more information. By default, when you open a field, the Details tab is displayed allowing you to modify the name, color, or hotkey of the field. You can also specify whether it is multi-value (Is multi-value) or if it allows for values with no evidence in the document to be processed (Requires reference). The multi-value option allows for a field to have multiple values, without being restricted to a specific list.

有关如何使用这两个字段的更多信息，请查看以下说明：

You can also select the Type of the field from the dropdown list, or add a Default value. Use the Default value field to define values to be populated in the Extraction Result, in case there is no value for the field identified in the document.

Under Validation settings, you have the option to set an Extraction confidence threshold. This threshold is considered when validating the field in the Validation Station. To set an extraction confidence threshold, go to Extraction confidence threshold and input a value ranging from 0 to 100.

Figure 2. Overview of the Details tab of a field

You can choose to enable Validator notes from the Details tab. By setting up validator notes, human validator can add notes about the decision they have taken during validation. You can configure the following settings:

可以使用旁边显示的“删除”按钮删除已创建的字段，也可以使用拖放功能对其进行重新排序。

A field can also be deleted from the Details window, by selecting Delete.

重复以上步骤即可创建多个组、类别和文档类型，您后续还可使用“搜索”字段对其进行筛选。

规则选项卡

字段规则可帮助您优化提取结果，并在运行工作流时自动对其进行验证。它们的作用是提高提取效率，并通过高亮显示来帮助您轻松验证需要在验证站点中注意的字段。您可以创建适用于一个字段的多个规则。

You define a rule by setting the Evaluator type and the Criticality level.

评估者类型

Use the Evaluator Type to specify how the defined rules should be evaluated. There are two evaluator types that you can choose from: AND, OR.

严重性级别

Indicates the criticality of all rules defined for a field. You cannot set a MUST level if the rule is broken in the Validation Station session. There are two criticality levels that you can choose from: MUST, SHOULD.

识别出设置的严重性级别后，将触发创建的规则。

When you want to submit a rule, a MUST rule requires 100% success, otherwise the Submit operation fails. A SHOULD rule allows you to Submit it even if the rule is broken.

You can always check if a rule is broken by using the helper method from the ExtractionResult Class class, that resides in the UiPath.DocumentProcessing.Contracts activity package.

Table 2. Table displaying Criticality levels and their descriptions

Once you have selected the Evaluator Type and the Criticality Level, you must set a type applicable for your newly created rule. There are several options you can choose from. Here's a complete list with all the available ones:

规则类型

下表显示了每个可用规则类型的详细信息，并根据严重性级别和评估程序类型进行分类。

使用规则

Let's take a practical example to better understand the applicability of these rules. We will create a set of rules for the Address field of document. Check the following example steps to learn how you can create a new rule or a set of rules for a field:

以下动图显示了前述步骤。

图 3. 显示如何为字段添加三个规则的动图

正在编辑

您可以“编辑”已创建的任何组、类别或文档类型的名称。这可以通过选择三个配置级别中的其中一个级别，然后编辑“名称”字段来完成。

正在删除

您也可以删除组、类别和文档类型。有两个可用选项：

In both cases, a pop-up is displayed asking you to confirm the deleting action. Select Delete to approve the action.

自定义和辅助功能

热键和颜色会自动分配给新创建的字段。您可以使用它们来提高可见性并更快地浏览分类。通过单击热键或颜色代码字段来自定义它们。

A customized field with color and hotkey can instruct the Validation Station and the Template Manager to use the assigned color when displaying the field and to use the assigned hotkey as a shortcut for providing values to fields. See the Validation Station page for more information about how to use the field shortcuts to assign values to a field.

To assign a color and a hotkey for a field, select the field, and choose a certain color code in the Color field, and then select a specific hotkey from the Hotkey menu.

Navigate through the Taxonomy Manager by using the keyboard shortcuts. Select Show available keyboard shortcuts and activate the Toggle keyboard shortcuts option to avoid the accidental triggering of the keyboard shortcuts. Nodes can also be collapsed.