タクソノミーを読み込み

UiPath.IntelligentOCR.Activities.TaxonomyManagement.LoadTaxonomy

タクソノミー マネージャーを使用して作成した taxonomy.json ファイルを変数に変換して、他のアクティビティでも再利用できるようにします。

プロパティ

共通

• 表示名 - アクティビティの表示名です。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

出力

• 分類データ - 読み込む分類データです。DocumentTaxonomy 変数に格納されます。この出力結果は後ほど、分類データを入力値として受け取るアクティビティで使用されます。
  重要: Intel Xe GPU を使用していて、タクソノミー マネージャーが正しく表示されない場合は、グラフィック ドライバーを最新バージョンに更新することをお勧めします。詳しくは、こちらのページをご覧ください。

タクソノミー拡張メソッド

Serialize()

DocumentTaxonomy オブジェクトで呼び出されます。Serialize() メソッドは、オブジェクトの JSON 表現を返します。これを格納しておけば、後で取得して使用できます。

Deserialize(String)

DocumentTaxonomy.Deserialize(jsonString) スタティック拡張は、DocumentTaxonomy オブジェクトを返します。このオブジェクトは、パラメーターとして渡された JSON エンコードデータでハイドレートされています。

GetFields(String)

DocumentTaxonomy オブジェクトで呼び出されます。DocumentTypeId 文字列で呼び出された GetFields() メソッドは、そのドキュメントの種類内で定義されたフィールドのリストを返します。

タクソノミー マネージャーを使用して、現在の自動化プロジェクト独自のタクソノミー ファイルを作成・編集できます。このタクソノミー ファイルにはユーザーが定義したドキュメントの種類が含まれ、それらはグループ別とカテゴリ別に整理されています。

[タクソノミーを読み込み] アクティビティを使ってタクソノミー ファイルを .NET データ型に変換して、次のアクティビティの入力値として渡すことで、このタクソノミー ファイルを使用できます。

• ドキュメント分類スコープ
• 分類器トレーニング スコープ
• 抽出器トレーニング スコープ
• 検証ステーションを提示

タクソノミー マネージャーは、v1.6.0 またはそれ以降の UiPath.IntelligentOCR.Activities パッケージをプロジェクトの依存関係としてインストールした後でのみ使用できます。パッケージをインストールすると、[ウィザード] セクションのリボンに [タクソノミー マネージャー] ボタンが表示されます。

図 1. Studio のリボンの タクソノミー マネージャー の概要

タクソノミー マネージャーを使用する

[タクソノミー マネージャー] ウィンドウでは、ドキュメントの種類を作成し、グルーブ別とカテゴリ別で整理することができます。プロジェクトでこのウィンドウを初めて開いたときには、グループ、カテゴリ、ドキュメントの種類のいずれも定義されていません。

図 2. ドキュメントの種類またはフィールドをマッピングする前のタクソノミー マネージャー

構造を確立する

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

グループを作成する

グループを作成するときは、グループ内に作成するドキュメントの種類のカテゴリも必要です。 これを行うには、[ グループ] ボタンを使用します。 グループの名前を選択したら、[ 保存 ] ボタンを使用するか Enter キーを使用して保存できます。

カテゴリを作成する

グループを定義して選択すると、定義されたボタンを使用して、グループ内に カテゴリ および/または ドキュメントの種類 を作成できます。 [ 保存 ] を選択するか、Enter キーを使用して構成を保存します。

ドキュメントの種類を作成する

ドキュメントの種類は、グループの一部または 1 つのドキュメントとして作成できます。グループ内に作成した場合は、グループが選択されていることを確認して、[ ドキュメントの種類] を選択します。

ドキュメントの種類を 1 つのファイルとして作成する場合は、グループが選択されていないことを確認し、[ドキュメントの種類] を選択します。[ドキュメントの種類] を選択したら、ファイルの名前を入力して [保存] を選択します。

手記： v2020.10 の Studio の使用時に Orchestrator から Document Understanding アクションを送信すると、 カテゴリのないドキュメントの種類がタクソノミーに作成されないようにしてください。

既に作成済みのドキュメントの種類を選択して、名前を変更したり、一意の ID をクリップボードにコピーしたり、それを別のグループまたはカテゴリに再割り当てしたりする (またはどこにも割り当てない) ことができます。ドキュメントの種類のコードを入力することもできます。

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

フィールドを作成する

[ドキュメントの種類] を選択すると、[ フィールド ] ボタンを使用して新しいフィールドを作成できるようになります。 [フィールド] ボタンを選択したら、名前を入力し、ドロップダウン リストから種類を選択できます。

[フィールド] カテゴリには、[詳細] と [ルール] の 2 つのタブがあります。[ 詳細 ] タブには、選択したフィールドに関する情報としてフィールド名、割り当てられたホットキー、フィールドの種類などが表示されます。[ ルール ] タブでは、フィールドの抽出結果が満たす必要があるルールを作成できます。

使用可能なフィールドの種類は次のとおりです。

• テキスト
• Number
• 日付 - この型を選択すると、期待される形式を指定することもできます (オプション)。
  注:

  必要な形式を追加する場合は、MSDN (MicroSoft Developer Network) に準拠した形式を使用します。

  これは抽出器が使用可能な形式であり、[データ抽出スコープ] アクティビティが日付を解析して、日、月、年の各構成要素への分解を試みるときに使用されます。

• 名前
• Address
• 設定 - この型を選択すると、あらかじめ設定されたリストから複数の値をフィールドに追加できます。
• Boolean
• 表 - この型を選択すると、列を追加したり、列の名前と型を編集したりできるため、表の構造を編集できます。

詳細タブ

新しいフィールドが作成されたら、それを選択して詳細情報を表示します。 既定では、フィールドを開くと [ 詳細 ] タブが表示され、フィールドの名前、色、ホットキーを変更できます。 また、複数値にするか ([複数値である])、ドキュメント内に証拠がない値の処理を許可するか ([参照が必要]) を指定することもできます。 複数値オプションを使用すると、特定のリストに制限されることなく、フィールドが複数の値を持つことができます。

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

• 複数値である: フィールドが複数値として設定されている場合、その特定のフィールドに対して複数の値を報告できます。 たとえば、エントリ数は可変の「取締役のリスト」を抽出するとします。 単一列のテーブルのような複数値フィールドを想像してみてください。
• 参照が必要: フィールドに参照が必要な場合、検証ステーションに表示されているドキュメントから選択しない限り、フィールドに値を追加できません。 特殊なフィールドにおいて、ドキュメントに表示されない可能性がある値をキャプチャする場合は、[参照が必要] をオフに切り替えることができます。 その効果として、ユーザーがその値の取得元であるドキュメント内の場所を指定せずに値を追加できるようになります。

また、ドロップダウン リストからフィールドの [型 ] を選択するか、[ 既定値] を追加することもできます。 ドキュメント内で特定されたフィールドに値がない場合に、 抽出結果 に入力される値を定義するには[既定値] フィールドを使用します。

図 3. フィールドの [ 詳細 ] タブの概要

検証者のコメントは、[詳細] タブから有効化できます。検証者のコメントを設定すると、人間の検証者は検証中に行った意思決定に関するメモを追加できます。次の設定を使用できます。

• 読み取り専用: 有効化すると、[抽出結果] フィールドに設定されている検証メモをメッセージとして、人間の検証者に検証ステーションで表示できます。無効化すると (既定のステート)、人間の検証者は検証ステーションでそのメモを編集して、意思決定に関する情報をロボットに伝えることができます。
• テキスト: テキスト を選択すると、検証者のコメントが検証ステーションにテキスト メッセージ (編集が有効化されている場合は編集可能なテキスト) として表示されます。 人間の検証者は、検証ステーションで最大 200 文字のメッセージを表示、編集、または追加できます。
• オプション: [オプション] を選択すると、一連のラジオ ボタンを設定できます。これらのボタンは人間の検証者に表示され、読み取り専用でない場合は検証ステーションで選択できます。最大 10 個のオプションを追加できます。

ヒント: 検証者のコメントに関連する 2 つのメソッド「GetFieldValidatorNotes(<fieldId>)」と「SetFieldValidatorNotes(<fieldId>, <validatorNote>)」について詳しくは、UiPath.DocumentProcessing.Contracts セクションの「ExtractionResult クラス」をご覧ください。

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

フィールドは、[ 詳細 ] ウィンドウから [ 削除] を選択して削除することもできます。

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

ルール タブ

フィールド ルールを使用すると、抽出結果を最適化し、ワークフローの実行時に結果を自動的に検証できます。 検証ステーションの役割は、抽出効率を高め、検証ステーションで注意が必要なフィールドを強調表示して簡単に検証できるようにすることです。 1 つのフィールドに適用される複数のルールを作成できます。

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

エバリュエーターの種類

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

表 1. エバリュエーターの種類、その説明、および例を示す表

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

重要度レベル

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

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

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

ルールが満たされているかどうかは、UiPath.DocumentProcessing.Contracts アクティビティ パッケージ内の ExtractionResult Class クラスのヘルパー メソッドを使用して確認できます。

表 2. 重要度レベルとその説明を表示する表

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

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

• 空でない
• 予想される値
• 次で始まる
• 次で終わる
• 次の値を含む
• 固定長
• メール アドレス
• 正規表現
  手記： ルールを作成したフィールドの種類によって、選択できるルールの種類の数が決定されます。 たとえば、 Text フィールドの場合はすべてのルールの種類が表示されますが、 Date フィールドの場合は [ 空でない ] と [ 予想される 値] の 2 種類しか表示されません。

ルールの種類

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

表 3. ルールの種類とその説明 (重要度レベルとエバリュエーターの種類による)

ルールの種類	説明	フィールドの種類	重要度レベル	エバリュエーターの種類
空でない	抽出された値は空にすることはできません。つまり、フィールドは必須です。 値が見つからない場合は、検証/手動の入力が必要です。	次の型のフィールドに適用できます。 Number text Date アドレス name Set Boolean	MUST SHOULD	AND OR
予想される値	ユーザーがすべての可能な値を定義し、抽出されたデータは、ルールの作成時に入力として追加された値の 1 つです (たとえば、雇用主の種類は「フルタイム」、「パートタイム」、「インターンシップ」のいずれかです)。	次の型のフィールドに適用できます。 Number text Date	MUST SHOULD	AND OR
式	データを抽出するルールとして機能する数式を定義します。	number 型のフィールドに適用できます。 ルールの設定時に条件が必要です。 次のいずれかのオプションを選択します。 次の値に等しい 次の値と等しくない 次の値より大きい 次の値以上 次の値以下 数式は必須です。 定義済みの演算子を使用して式を定義します。 以下の例をご覧ください。 合計 * 正味単価\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

ルールを使用する

これらのルールの適用性をよりよく理解するために、実際の例を見てみましょう。 ドキュメントの [住所 ] フィールドの一連のルールを作成します。 フィールドに対して新しいルールまたは一連のルールを作成する方法については、次の手順の例をご覧ください。

1. [タクソノミー] パネルでフィールドを選択します。
2. [ ルール ] タブに移動します。
3. [ 新規追加] を選択して、新しいルールを追加します。
4. full addressルールを入力します。[型] が [次を含む] で、[式] が [st, str, street] である
5. [ エバリュエーターの種類] を選択します。

   この例では、 [ OR] を選択します。

6. [重要度] レベルを選択します。

   この例では、[ MUST] を選択します。

7. [ 新規追加] を選択します。
8. phone numberルールを入力します。その場合、[種類] は [空でない] です。
9. [ 新規追加] を選択します。
10. city or stateルールを入力します。[型] が [次を含む] で、[式] が [city, state] である

次のアニメーション画像は、前に説明した手順を示しています。

図4. フィールドに 3 つのルールを追加する方法を示すアニメーション画像

その他のオプション

編集中

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

削除しています。

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

• 削除するオブジェクトの親要素で [削除] を選択します。
• 削除するオブジェクトを選択しながら、[削除] を選択します。

どちらの場合も、削除操作の確定を求めるポップアップが表示されます。 [ 削除 ] を選択してアクションを承認します。

カスタマイズとアクセシビリティ

新しく作成したフィールドには、ホットキーと色が自動的に割り当てられます。これらを使用して、可視性を向上させ、分類データ間をすばやく移動できます。ホットキーまたは色コード フィールドをクリックして、フィールドをカスタマイズします。

色とホットキーでカスタマイズされたフィールドによって、フィールドを表示する際に割り当てられた色を使用するよう、および割り当てられたホットキーをフィールドに値を指定するためのショートカットとして使用するよう、検証ステーションとテンプレート マネージャーに指示できます。 フィールドのショートカットを使用してフィールドに値を割り当てる方法の詳細については、「 検証ステーション 」をご覧ください。

フィールドに色とホットキーを割り当てるには、フィールドを選択し、[ 色 ] フィールドで特定のカラー コードを選択してから、[ ホットキー ] メニューから特定のホットキーを選択します。

キーボード ショートカットを使用してタクソノミー マネージャー内を移動します。 「 使用可能なキーボードショートカットを表示 」を選択し、「 キーボードショートカットの切り替え 」オプションをアクティブにして、キーボードショートカットが誤ってトリガーされないようにします。 ノードは折りたたむこともできます。

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