アクティビティ

フォーム抽出器

UiPath.IntelligentOCR.Activities.DataExtraction.FormExtractor

注: ライセンスの都合上、[フォーム抽出器] アクティビティではロボットの実行にインターネット接続が必要になります。

フォーム抽出器は、ドキュメント内の単語の位置を分析するか、署名を検出することにより、特定の情報を抽出、照合、およびレポートするのに最適です。このアクティビティは、[データ抽出スコープ] アクティビティと組み合わせた場合にのみ使用できます。[フォーム抽出器] アクティビティを [UiPath ドキュメント OCR] アクティビティとともに使用すると、手書きのテキストも検出できます。

プロパティ

共通

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

入力

API キー - アカウントの API キーを指定します。ローカルのプロジェクト設定または Document Understanding フレームワークで定義されている場合、[API キー] フィールドは自動的に事前入力されます。
エンドポイント - UiPath サーバーの URL です。既定のエンドポイントは https://du.uipath.com/svc/formextractor です。詳細については、「Document Understanding のパブリックエンドポイント」をご覧ください。
重複率の最小値 - 抽出を実行するために必要な、ドキュメント内のボックスとテンプレート内のボックスが重複する領域の割合 (パーセント) の最小値を指定します。パーセント値は 0 から 100 の間で設定できます。既定値は 65 です。
ドキュメントを送信 - より良いサポート、トラブルシューティング、パフォーマンスの向上のため、ドキュメントを送信します。
タイムアウト - サーバーからの応答があるまで待機する時間をミリ秒で指定します。指定した時間が経過しても実行が完了しない場合には例外をスローします。既定値は 100000 ミリ秒 (100 秒) です。

その他

プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。
注: 1 つのドキュメントの種類に対して、複数のテンプレートを定義できます。アクティビティの実行時、抽出器は最初のページで見つかった情報に基づいて、最も合うテンプレートを選択します。

テンプレートマネージャーウィザード

分類データで定義されたドキュメントの種類のテンプレートの作成、編集、管理ならびにエクスポート/インポートを可能にします。

テンプレートを作成する

[データ抽出スコープ] 内のワークフローに [フォーム抽出器] アクティビティを追加します。
[テンプレートを管理] ボタンをクリックして抽出器を構成します。
- [テンプレートマネージャー] ウィンドウが開きます。
[テンプレートを作成] ボタンをクリックして新しいテンプレートを作成します。

注:
UiPath.IntelligentOCR.Activities パッケージが v5.1.0 に更新されている場合、[OCR を強制適用] パラメーターは [PDF に OCR を適用] に置き換えられています。古いパラメーターと新しいパラメーターとの対応は次のとおりです。

• [OCR を強制適用] = [True] は [PDF に OCR を適用] = [はい] に置き換えられています

• [OCR を強制適用] = [False] は [PDF に OCR を適用 = [自動] に置き換えられています

• [OCR を強制適用] = [空] は [PDF に OCR を適用] = [自動] に置き換えられています

• [OCR を強制適用] = <ユーザー定義変数> は [PDF に OCR を適用] = [自動] に置き換えられています
[ドキュメントの種類] ドロップダウンリストから、テンプレートのドキュメントの種類を選択します。
注: [ドキュメントの種類] は、すべてタクソノミーに基づいています。必ず、プロジェクトのフォルダー内にタクソノミーを追加または作成してください。
[テンプレート名]] フィールドに名前を追加します。ドキュメントのバージョンやレイアウトを反映する適切な名前を選択してください。
[テンプレートドキュメント] フィールドにドキュメントパスを追加します。
- [参照] ボタンにより、ファイルのパスに移動します。
[OCR エンジン] ドロップダウンリストから OCR を選択し、必要に応じて設定します。
[設定] ボタンをクリックして、テンプレートの編集をトリガーします。

[PDF に OCR を適用] オプションは、PDF ドキュメントに OCR プロセスを適用するかどうかを指定します。ドロップダウンリストには、[True]、[False]、[自動] の 3 つのオプションがあります。

[True] に設定すると、ドキュメントのすべての PDF ページに OCR が適用されます。[False] にすると、デジタル入力されたテキストのみが抽出されます。既定値は [Auto] で、入力ドキュメントに応じてドキュメントに OCR アルゴリズムを適用する必要があるかを判断します。

各 OCR エンジンには、それぞれ独自のカスタムオプションが付属しています。各 OCR エンジンで利用可能なすべてのオプションに関する詳細は、こちらをご覧ください。既定の OCR エンジンは UiPath ドキュメント OCR です。

テンプレートを作成済みの場合、これを編集、エクスポート、または削除できます。

[削除] と [エクスポート] ボタンは、テンプレートを少なくとも 1 つ選択したときのみ使用できるようになります。個別のテンプレートの [編集] および [削除] オプションは、いつでも使用できます。

Boolean フィールド処理を設定する

チェックボックスを含むドキュメントの場合、[はい] や [いいえ] のオプションに関して既知の類義語を追加できます。または UiPath がコンパイルしたリストから始めることも可能です ([推奨する文字列を追加] の提示をご覧ください)。これらの値は、Boolean の内容解釈に使用されます。この解釈では、キャプチャした値を報告する [はい] または [いいえ] の値にマッピングします。

注: 追加した類義語に大文字と小文字の区別がある場合は、[大文字と小文字を区別] チェックボックスをオンにする必要があります。

テンプレートをエクスポートおよびインポートする

他のワークフローで作成およびエクスポートされたテンプレートをインポートできます。これらの機能を使用してプロジェクト間でテンプレートを共有します。フォーム抽出器を使用してドキュメントの種類を設定した後は、新しい実装でテンプレートを再設定する必要はありません。

エクスポートの手順

テンプレートをエクスポートするときに従う必要がある手順を以下に示します。

このページの前半で説明した手順に従い、1 つ以上のテンプレートを作成します。
エクスポートするテンプレートを選択します。
次のスクリーンショットのように、[エクスポート] オプション (元のファイルを含める/含めない) を選択します。元のファイルを含めるエクスポートでは、元のファイルが添付されます。
希望の名前でテンプレートのアーカイブを保存します。
テンプレートが保存されると、メッセージが表示されます。[OK] ボタンを選択します。

注:
テンプレートを作成したドキュメントのコンテンツを共有できない場合は、「元のファイルを含めない」オプションを使用します。他のプロジェクトでテンプレートアーカイブを共有およびインポートすることはできますが、編集や表示はできなくなります。

別のプロジェクトでインポートしたテンプレートを編集する場合は、エクスポートしてからインポートする際に「元のファイルを含める」オプションを使用してください。

インポートの手順

テンプレートをインポートするときに従う必要がある手順を以下に示します。

[インポート] ボタンを選択します。
アーカイブを選択します。インポートウィザードが表示され、選択したエクスポートアーカイブで使用できるドキュメントの種類とテンプレートがすべて提示されます。インポートするテンプレートを、適切なインポート オプション (元のファイル含む / 含まない) とともに選択します。
注:
- テンプレートがインポートされると、プロジェクトの分類データ内にドキュメントの種類が自動的に作成されます。同名のドキュメントの種類が既に存在する場合、名前の末尾に数字を付加して、もう 1 つのドキュメントの種類が作成されます。
- 元のファイルなしでエクスポートされたテンプレートをインポートする場合、または元のファイル含めずにテンプレートをインポートする場合、それらのテンプレートに対しては表示または編集のオプションを使用できません。

テンプレートのインポート時の特殊な状況

テンプレートをインポートすると、いくつかの特殊な状況が発生する場合があります。次の表で、各状況について、その特殊性を含めて説明します。

インポートの種類	アクティビティの動作
新しいドキュメントの種類	新しいドキュメントの種類をインポートすると、ウィザードコンフィギュレーターに新しいフィールドが追加され、新しいテンプレートが作成されることを知らせます。
重複するドキュメントの種類	同一のドキュメントの種類をインポートすると、次の警告メッセージが表示されます。このテンプレートは既に存在するため、上書きされます。
拡張テンプレート	既存のフィールド以外のフィールドが追加されたドキュメントの種類のテンプレートをインポートすると、次の警告メッセージが表示されます。このドキュメントの種類は次のように更新されます: 次のフィールドは存在しないため作成されます。
拡張されたドキュメントの種類	既存のフィールド以外のフィールドが追加されたドキュメントの種類をインポートすると、次の警告メッセージが表示されます。このドキュメントの種類は次のように更新されます: 次のフィールドにはインポートする設定がありません。
同じ名前で内容が異なるドキュメントの種類	既存のものと同じ名前でありながら、フィールドが異なるドキュメントの種類をインポートすると、次の警告メッセージが表示されます。このドキュメントの種類は次のように更新されます: 次のフィールドは存在しないため作成されます。次のフィールドにはインポートする設定がありません。
表が欠落したドキュメントの種類	ユーザーが表を含まないドキュメントの種類をインポートすると、次の警告メッセージが表示されます。このドキュメントの種類は次のように更新されます: 次のフィールドにはインポートする設定がありません。
表が拡張されたドキュメントの種類	余分な列がある表を含むドキュメントの種類をインポートすると、次の警告メッセージが表示されます。このドキュメントは次のように更新されます。次のフィールドは存在しないため作成されます。
表が縮小されたドキュメントの種類	列が欠落した表を含むドキュメントの種類をインポートすると、次の警告メッセージが表示されます。このドキュメントは次のように更新されます。次のフィールドにはインポートする設定がありません。
異なるドキュメントの種類による表のテンプレート	異なるドキュメントの種類の表を含むドキュメントの種類のテンプレートをインポートした場合、新しいテンプレートが作成されます。タクソノミーに、ドキュメントの種類が異なるフィールドを持つ表が含まれている場合、次の警告メッセージが表示されます。 IDが `xyz` のフィールドが、インポートされたタクソノミーと既存のタクソノミーの両方で見つかりましたが、それらの種類が一致しません (両方がテーブルであるか、両方ともテーブル以外である必要があります)。

テンプレートエディターウィザード

一般的な考慮事項

テンプレートエディターは、検証ステーションにある機能をベースにして構築されています。テンプレートのボタンをクリックしてアクセスします。

検証ステーションの基本的な使用法については、こちらのセクションをご覧ください。

検証ステーション画面の右側で利用可能なオプションのほかに、テンプレートエディター固有のオプションが 2 つあります。

オプション	説明
	アンカー選択モードを設定します。
	アンカーの選択をすべてクリアします。

新しいテンプレートを作成すると、テンプレートエディターを最初に開くときに説明のテキストが表示されます。テキストに再度アクセスする場合は、以下の手順を実行します。

表の情報は、セルレベルまたは表レベルで変更できます。セルレベルで表を設定する方法について詳しくはこちらを、表レベルで表を設定する方法について詳しくはこちらをご覧ください。

アンカーを設定する

テンプレートマネージャーからテンプレートエディターを開いたら、アンカーを定義できます。アンカーは [選択モード] オプションに含まれています。

ページレベルのテンプレートを定義または編集するときに最初に実行すべきことは (任意ですが)、[ページ 1 の一致情報] を選択することです。この手順は、固定フォームテンプレートの場合にのみ必要になります。

画面左側に表示される [ページ 1 の一致情報] の選択には、テンプレートの最初のページからのテキスト入力 (トークンのみが受け入れられます) が必要です。これは、その特定のテンプレートレイアウト内で常に同じ位置にあり、特定のドキュメントの種類に定義されたすべてのテンプレートで一意の単語のグラフを (単語間の相対距離や角度を考慮して) 形成します。

言い換えれば、[ページ 1 の一致情報] (および他のすべてのページ一致情報フィールド) は特定ページの「指紋」であり、実行時に適合するテンプレートを識別するのに幅広く使用されます。

このため、[ページ 1 の一致情報] フィールドには 10 ～ 20 の単語を選択することが強く推奨されます。できれば長く、ページ領域全体に広がるようにしてください。

他の「ページの一致情報」系のフィールド (テンプレートページごとに 1 つ) には、その特定のページからデータ抽出を試みていて、テンプレート間の一意性が不要な場合にのみ値を入力する必要があります。特定のページからフィールドを抽出する必要がない場合、そのページのページレベルの一致情報の定義は必須ではありません。

簡易フィールドを設定する

テーブル以外のすべてのフィールドでは、テンプレートの設定は、カスタム領域の選択とそれらの特定フィールドへの割り当てで構成されます。

固定フォームの設定の場合、データフィールドはカスタム領域の選択を使用してのみ設定できます。

1 つのフィールドに対して、(+) ボタンを使用してこうしたカスタム領域を 1 つ以上定義できます。1 つのフィールドに 2 つ以上のカスタム領域が定義されている場合、実行時に、フィールドが分類データで単一の値として定義されていると、すべての値が 1 つの報告値に連結されます。フィールドが複数値として定義されていると、各値が個別に報告されます。

以下のアニメーションは、トークンとカスタム領域の選択の違いを示しています。

各フィールドの横のアイコンは、サポートされている選択の種類を示します。

注:

空の領域を選択した場合、選択領域は自動的に [カスタム領域] として設定されます。選択した領域にテキストが検出されると、選択領域の種類として [トークン] または [カスタム領域] のどちらかを選択するよう求められます。

検証ステーションの「選択モード」機能を使用して、トークンとカスタム領域間の選択の切り替えをロックします。

テーブルを設定する

上記のように、トークンによってのみ (「ページの一致情報」系のフィールドなど) またはカスタム領域によってのみ (簡易フィールドなど)、情報を追加できるフィールドがあります。「テーブル」系のフィールドでは、以下を行うことができます。

テーブルエディターを展開したら、各セルを 1 つずつ定義する - 各セルに個別にカスタム領域の選択を追加します。
テーブルマークアップ機能を使用する - テーブル領域をマークし、行および列の区切りを作成して、マークしたテーブルをフィールドに割り当てます。抽出領域の列数と行数がテンプレート領域と同じであることを確認します。

テーブルマークアップ機能の使用方法については、以下のアニメーションをご覧ください。

アンカーの構成

データの抽出元のカスタム領域の境界は、フィールドレベルのアンカーの使用という特殊な方法で定義します。それにより、フィールドレベルの設定に基づいてデータ抽出の対象を指定し、フォーム抽出ルールをより柔軟に定義できるようになります。

その結果、実行時にフォーム抽出器が以下の方法を認識します。

ページレベルのテンプレートが一致するかどうかを明らかにし、認識する最適なページレベルのテンプレートの一致に従って情報を抽出する。
アンカーベースの設定が一致するかどうかを明らかにし、処理するドキュメントでの用途に応じて情報を抽出する。
すべての利用可能なオプションの最高の結果 (最も可能性の高い一致) を報告できるように、考えられるすべての一致に対する適切な信頼度スコアを計算する。

新しいアンカーの設定を作成する

アンカー選択モードになっていることを確認します。
値の領域の周囲にボックスを描画します。
値の領域のラベル (メインアンカー) を選択します。具体的には、選択範囲の最初の単語をクリックしてから、最後の単語を Ctrl キーを押しながらクリックするか、単語範囲の開始位置でマウスをクリックし、そのままドラッグして、終了位置で放してキャプチャします。
注: ラベルには、同じ表示ラインからの連続する単語だけを含めることができます。
ラベルを一意に特定する追加のアンカーを選択します。同じ選択の原則が適用されます。
特定のフィールドで [値を抽出] を選択することによって、アンカーの構成を適切なフィールドに割り当てます。

注: こちらの例を使用して、テンプレートを作成し、抽出領域とアンカーを定義する方法を学ぶこともできます。

既存のアンカーの設定を編集する

アンカーの設定を強調表示します。
アンカーの設定を変更します (アンカー、ラベル、(必要に応じて) 値領域の削除、新しい要素の追加など)。
[抽出値を変更] オプションを使用して、フィールドの関連付けを更新します。
注:
- 対象の領域を削除するとすべてのアンカーが削除されるので、最初からやり直します。
- ラベル (メインアンカー) を削除すると、残りのアンカーのうち最初に作成されたものが新しいラベルになります。

既存のアンカー設定を削除する

アンカーの設定を削除するには、以下の操作を実行します。

保存された値に対して、[不足としてマーク] オプションを使用します。
指定したフィールドに定義されたアンカーのリストの場合は、[値を削除] を使用します。

さまざまな設定を組み合わせる

同じドキュメントの種類に対して、必要な数のテンプレートを定義できます。複数のページレベルテンプレート、同じフィールドに対する複数のアンカー、ページレベルとフィールドレベルの両方のアンカーを含むテンプレートも利用できます。

注:

フィールドレベルのアンカーを定義するときは、ラベルが値領域の近くにあることを確認してください。また、同じドキュメント内の複数の場所に同じテキスト構造がある場合は、ラベルが追加のアンカーでサポートされていることを確認してください。
ラベルとアンカーが長いほど、精度が高くなります。
値の領域は常に、ラベル (メインアンカー) に対する相対位置に基づいて計算されます。それに応じて、メインアンカーを選択します。
フィールドレベルのアンカーを使用すると、フィールドをテンプレート内で移動して、引き続きキャプチャできるため、ドキュメントレイアウトをさらに自由に変更できるようになります。