タクソノミー マネージャー

重要:

In case you use an Intel Xe GPU and Taxonomy Manager is not displayed properly, we recommend updating the graphics driver to the latest version. For more information, please visit this page.

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

構造を確立する

最初の手順として、グループまたはドキュメントの種類を作成します。これら 2 つの違いは、グループは階層構造になっており、ドキュメントの種類は単一のファイルとして作成できる点です。複雑なプロジェクトの場合はグループ、カテゴリ、ドキュメントの種類を作成する必要がありますが、簡易なプロジェクトで必要になるのは 1 つまたは 2 つのドキュメントの種類のみです。

グループを作成する

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.

注:

When a Document Understanding Action is submitted from Orchestrator while using Studio version 2020.10, make sure that the taxonomy has no document types created without a category.

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.

ドキュメントの種類を保存すると、[ドキュメントの種類の ID] が生成されます。編集のためにドキュメントを開くと、[ドキュメントの種類名] タブの横にこの ID が表示されます。[ドキュメントの種類の ID] は種類が Group.Category.Document の構造をしており、クリップボードにコピーできます。[ドキュメントの種類の ID] コードは任意の機能であり、この機能を使用してドキュメントを検索したり、ドキュメントを分類データで定義するドキュメントの種類にマップできます。

ドキュメントの種類の表示設定を構成する

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:

• OCR confidence threshold: Set a minimum confidence threshold at the document type level. When the document is displayed in the Validation Station, both the OCR confidence level and the Extraction confidence level for a field, would have to be higher than the threshold you configure in the Taxonomy Manager. The default value for OCR confidence threshold is 90%.

• Date display format: The date format displayed for the document type.

  既定値は YYYY-MM-DD です。

• Number decimal separator: The number decimal separator you want to use for the document type.

• Number thousand separator: The number thousand separator you want to use for the document type.

フィールドを作成する

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.

次のフィールドの種類を使用できます。

• テキスト

• Number

• Date - Choosing this type also lets you specify an expected format, which is optional.

  注:

  予想される形式を追加する場合は、MSDN (MicroSoft Developer Network) 準拠の形式を使用してください。

  This format may be used by extractors and is used by the Data Extraction Scope activity when trying to parse a Date into its constituent Day, Month, and Year parts.

• 名前

• Address

• Set - Choosing this type lets you add multiple values to the field from a pre-established list.

• Boolean

• Table - Choosing this type lets you edit the structure of the table, as you can add columns and edit their name and type.

詳細タブ

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.

2 つのフィールドの使用方法について詳しくは、以下の説明をご覧ください。

• Is Multi-Value: If a field is set as multi-value, you can have more than one value reported for that particular field. For example, you want to extract a "List of Directors" where you can have variable number of entries. Imagine a multi-value field like a single-column table.
• Requires reference: When a field requires reference, you can add a value to it only if you select something from the document you see in Validation Station. For special fields in which you want to capture values that are maybe not visible in the document, you can switch Requires Reference to Off. Effect will be that user can add a value without specifying a place in the document where that values comes from.

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:

• Read-only: If enabled, the human validator can view any validator notes set on the ExtractionResult field in Validation Station, as a message. If disabled (default state), the human validator can also edit that note in Validation Station and thus communicate back to the robot information about the decision taken.
• Text: If Text is selected, the validator note is displayed as a text message (or editable text when editing is enabled) in Validation Station. The human validator can view, edit, or add a maximum of 200 characters message in Validation Station.
• Options: If you select Options, you can configure a series of radio buttons that the human validator can view and, if not read-only, select in Validation Station. You can add a maximum of 10 options.

ヒント:

Check the ExtractionResult Class page from the UiPath.DocumentProcessing.Contracts section for more information on the two methods related to validator notes, GetFieldValidatorNotes(<fieldId>) and SetFieldValidatorNotes(<fieldId>, <validatorNote>).

作成したフィールドは、フィールドの横にある削除ボタンを使用して削除したり、ドラッグ アンド ドロップ機能を使用して並べ替えたりすることができます。

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

この手順を繰り返すことにより、複数のグループ、カテゴリ、ドキュメントの種類を作成できます。これらは、[検索] フィールドを使用することでフィルター処理できます。

ルール タブ

フィールド ルールは、抽出結果を最適化しワークフロー実行時に自動的に検証するのに役立ちます。抽出を効率よく行い、検証ステーションで必要なフィールドを強調表示して人間が簡単に検証できるようにする役割があります。1 つのフィールドにつき複数のルールを作成して適用できます。

ルールを定義するには、[エバリュエーターの種類] と [重要度レベル] を設定します。

エバリュエーターの種類

エバリュエーターの種類を選択して、定義したルールの評価方法を指定します。AND または OR の 2 種類から選択できます。

Table 1. Table showing Evaluator types , their descriptions, and examples for them

エバリュエーターの種類	説明	例
AND	すべてのルールを実行する必要がある場合は、このエバリュエーターの種類を使用します。	ルール: 請求書番号は A で始まり X で終わる 有効な結果: 有効なフィールド値は A123X です。 無効な結果: 有効なフィールド値は A123 です。
OR	実行するルールが 1 つだけの場合は、このエバリュエーターの種類を使用します。	ルール: 請求書番号は A または 123 で始まる 有効な結果: 有効なフィールド値は A123、123 です。 無効な結果: 有効なフィールド値は 234、1A23 です。

重要度レベル

フィールドに定義されたすべてのルールの重要度を示します。検証ステーション セッションでルールが満たされていない場合は、MUST レベルを設定することはできません。重要度レベルは MUST または SHOULD の 2 種類から選択できます。

作成したルールは、設定した重要度レベルが識別されるとトリガーされます。

ルールを送信する際、MUST レベルのルールは 100% 満たされている必要があります。満たされていない場合、送信操作は失敗します。SHOULD レベルのルールの場合は、ルールが満たされていなくても送信できます。

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

	説明
MUST	作成したルールが抽出結果プロセスに必ず含まれていなければならない場合は、この重要度レベルを使用します。
SHOULD	作成したルールが任意の場合は、この重要度レベルを使用します。

[エバリュエーターの種類] と [重要度レベル] を選択したら、新たに作成したルールの種類を設定する必要があります。選択できるオプションは複数あります。以下に、利用可能なすべてのオプションのリストを示します。

• 空でない
• 予想される値
• 次で始まる
• 次で終わる
• 次の値を含む
• 固定長
• メール アドレス
• 正規表現
  注:

  The field type for which you created a rule dictates the number of possible rule types from which you can select one. For example, a field of type Text displays all the possible rule types, while a field of type Date displays only two rule types, Is not empty and Possible values.

ルールの種類

次の表に、利用可能な各ルールの種類の詳細を、重要度レベルとエバリュエーターの種類に基づいて分類して示します。

Table 3. Rule types and their descriptions, depending on the criticality level and evaluator type

	説明	フィールドの種類	重要度レベル	エバリュエーターの種類
空でない	抽出された値は空にすることはできません。つまり、フィールドは必須です。 値が見つからない場合は、検証/手動の入力が必要です。	以下の型のフィールドに適用できます。 Number text Date アドレス name Set Boolean	MUST SHOULD	AND OR
予想される値	予想されるすべての値をユーザーが定義します。抽出されるデータはルールの作成時に入力として追加された値の 1 つです (たとえば、Employee Type (従業員の種類) は「full-time (フルタイム)」、「part-time (パートタイム)」、「internship (インターンシップ)」のいずれかです)。	以下の型のフィールドに適用できます。 Number text Date	MUST SHOULD	AND OR
式	データを抽出するルールとして機能する数式を定義します。	Applicable to fields of type number. A condition is required while configuring the rule. Choose one of the following options: 次の値に等しい 次の値と等しくない 次の値より大きい 次の値以上 次の値以下 数式は必須です。定義済みの演算子を使用して式を定義します。以下の例をご覧ください。 合計 * 正味単価\n- 合計 = 小計 + 納品 割引 - Sum 演算子は、表の列からすべての値を収集します。	MUST SHOULD	AND OR
次で始まる	これは固定のルールです。つまり、抽出された値は、ユーザーが追加した値のいずれかから開始する必要があります。	以下の型のフィールドに適用できます。 text アドレス name	MUST SHOULD	AND OR
次で終わる	これは、抽出された値がユーザーによって追加された値のいずれかで終わる必要があることを意味する固定のルールです。	以下の型のフィールドに適用できます。 text アドレス name	MUST SHOULD	AND OR
次の値を含む	これは、抽出された値がユーザーによって追加された値のいずれかを含む必要があることを意味する、固定のルールです。	以下の型のフィールドに適用できます。 text アドレス name	MUST SHOULD	AND OR
固定長	これは、抽出された値が特定の固定長である必要があることを意味する固定のルールです。	以下の型のフィールドに適用できます。 text アドレス name	MUST SHOULD	AND OR
メール アドレス	これは、抽出された値がメール形式で記述されている必要があることを意味する固定のルールです。	以下の型のフィールドに適用できます。 text アドレス name	MUST SHOULD	AND OR
正規表現	これは、抽出された値がユーザーによって追加された値のいずれかに類似する正規表現を含む必要があることを意味する、固定のルールです。	以下の型のフィールドに適用できます。 text アドレス name	MUST SHOULD	AND OR

ルールを使用する

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:

1. Select a field in the Taxonomy panel.
2. Go to the Rules tab.
3. Select Add new, to add a new rule.
4. Type in the full address rule, for which the Type is Contains, and the Expression is st, str, street.
5. Choose the Evaluator type. In this example, select OR.
6. Choose the Criticality level. In this example, select MUST.
7. Select Add new.
8. Type in the phone number rule, for which the Type is Is not empty.
9. Select Add new.
10. Type in the city or state rule, for which the Type is Contains, and the Expression is city, state.

以下のアニメーション画像は、前述の手順を示しています。

Figure 3. Animated image displaying how to add three rules for a field

その他のオプション

編集中

作成したグループ、カテゴリ、またはドキュメントの種類の名前を編集できます。それには、設定の 3 つのレベルのいずれかを選択し [名前] フィールドを編集します。

削除しています。

グループ、カテゴリ、ドキュメントの種類を削除することもできます。次の 2 つの利用可能なオプションがあります。

• Select Delete , at the parent element of the object you want to delete.
• Select Delete while selecting the object you want to delete.

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.

注:

タクソノミー マネージャーで行った変更は、プロジェクト独自の taxonomy.json ファイルに自動的に保存されます。