Document Understanding アクティビティ

最終更新日時 2025年4月16日

ドキュメントデータを抽出

UiPath.IntelligentOCR.StudioWeb.Activities.ExtractDocumentDataWithDocumentData<UiPath.IntelligentOCR.StudioWeb.Activities.DataExtraction.ExtendedExtractionResultForDocumentData>

説明

入力ファイルまたは Document Data オブジェクトからデータを抽出し、結果を Document Data オブジェクトに格納します。

はじめる前に

前提条件

[ドキュメントデータを抽出] アクティビティには、[ドキュメントデータ] または [ファイル] のいずれかの種類の入力オブジェクトが必要です。このアクティビティを使用するユースケースとしては、Document Data 型のオブジェクトを生成する [ドキュメントを分類] アクティビティの後に実行することが考えられます。

入力オプション

[ドキュメントデータを抽出] アクティビティは、入力として次のいずれかを受け取ります。

ドキュメントデータ - [ドキュメントを分類] アクティビティから
ファイル - [ファイル/フォルダーを取得] アクティビティまたは [最新のメールを取得] アクティビティから

生成 AI モデルでサポートされている言語

生成モデルでサポートされている言語は、使用されている OCR エンジンと同じであり、プロジェクトによって異なります。Predefined プロジェクトと Generative Predefined プロジェクトの場合、使用される OCR エンジンは UiPath Document OCR です。詳しくは、「OCR でサポートされている言語」をご覧ください。

アクティビティで使用されるモデル

[ドキュメントデータを抽出] アクティビティでは以下を使用します。

事前トレーニング済みの専門化されたモデル。すぐに利用可能で、DocPath に基づきます。
Document Understanding のモダンプロジェクトとクラシックプロジェクトにデプロイされた、事前トレーニング済みのカスタムモデル。
生成 AI による抽出モデル

既知の制限事項

プロジェクトの種類 [Generative Predefined] とそれに対応する抽出器は、Automation Suite では利用できません。

プロジェクトの対応 OS

Windows | クロスプラットフォーム

構成

デザイナーパネル

入力ファイル - ファイル自体、またはワークフローで他の「Document Understanding」系アクティビティ ([ドキュメントを分類] など) を使用している場合はそのドキュメントデータを指定する必要があります。
重要: 1 つのファイルに含めることができる最大ページ数は 500 です。この制限を超えるファイルは抽出できません。
プロジェクト - ドロップダウンリストからお使いの Document Understanding プロジェクトを選択する必要があります。利用可能なオプションは次のとおりです。
- Predefined – 標準的なシナリオに推奨される、事前トレーニング済みの専門家されたモデルを使用するクラシックプロジェクトの種類です。
  クラシックプロジェクトの請求ロジックについて詳しくは、「使用状況の測定と請求ロジック」をご覧ください。
- Generative Predefined - 事前トレーニング済みの生成 AI モデルを使用するモダンプロジェクトの種類です。ドキュメントデータを抽出するための入力として指示を入力できます。
  モダンプロジェクトの請求ロジックについて詳しくは、「使用状況の測定と請求ロジック」をご覧ください。
- 接続先のテナントおよびフォルダーにある既存のプロジェクト。
- カスタムプロジェクトは、Document Understanding に移動して作成できます。
  詳しくは、モデルの構築の概要をご覧ください。
注: テナントに 500 を超えるプロジェクトを作成し、[ドキュメントデータを抽出] アクティビティを使用した場合、UiPath Studio または Studio Web には、最初の 500 を超えるプロジェクトは表示されません。したがって、これらのプロジェクトは使用できません。

抽出器 - プロジェクトを選択した後に、使用する抽出器を選択することもできます。
- [Predefined] プロジェクトの場合、次の 2 つの選択肢があります。
  - 事前トレーニング済みのモデルを選択します。使用可能な事前トレーニング済みモデルのリストについては、「すぐに使えるモデル」をご覧ください。
    注: [ドキュメントデータを抽出] アクティビティは、選択した抽出器のドキュメントの種類で利用可能なフィールドの情報を抽出します (ドキュメントの実際の種類は関係ありません)。これは、生成 AI モデルには適用されません。
  - [Generative Extractor] を選択します。
    注: 生成 AI 抽出器に送信された情報は、LLM モデルインスタンスに送られます。このインスタンスは公開されておらず、送信されたデータは保存されることもトレーニング目的で使用されることもありません。
    
    重要:
    この機能は現在のところ監査プロセスの一部であり、レビューが完了するまで FedRAMP 承認の一部と見なすべきではありません。現在レビュー中の機能の完全なリストについては、こちらをご覧ください。
- [Generative Predefined] プロジェクトには抽出の選択肢が 3 つあり、それぞれ以下の特定のドキュメントレイアウトに合わせて調整されています。
  - Long Document Simple Layout Extractor - 主にテキストと見出しで構成される長文のドキュメントにお勧めです。たとえば、賃貸契約書、マスターサービス契約などのドキュメントに使用できます。
  - Long Document Complex Layout Extractor – 画像、手書き文字、フォームコントロール、フローティング吹き出しボックス、またはその他の複雑なレイアウトの種類などの要素を含む長文のドキュメントにお勧めです。たとえば、保険証券などのドキュメントに使用できます。
  - Short Document Complex Layout Extractor – 画像、手書き文字、フォームコントロール、フローティング吹き出しボックス、またはその他の複雑なレイアウトの種類などの要素を含む短いドキュメントにお勧めです。たとえば、政府発行の ID、医療の問診票などのドキュメントに使用できます。
- 分類結果を使用: [データ型を生成] プロパティが false に設定されている場合、[分類結果を使用] オプションを選択できます。このオプションを選択すると、[ドキュメントを分類] アクティビティの結果として生成されるドキュメントの種類に基づいて、推奨される抽出器が自動的に使用されます。
  そのドキュメントの種類を処理できる抽出器が複数ある場合は、エラーが返されます。このシナリオでは、使用する抽出器を手動で選択する必要があります。
ドキュメントの種類の詳細 - [Generative] オプションを選択した場合に表示されます。抽出対象のフィールドを識別するためのプロンプトです。キーと値のペアとして指定します。キーはフィールドの名前を、値はフィールドの説明を表します。抽出器が対象値を識別するのに役立ちます。このフィールドを選択すると、次のオプションがペアになったプロンプトが表示されます。
- フィールド名 - 抽出するフィールド名 (例: 期限) を入力する必要があります (最大 30 文字)。
- 指示 - 対応するフィールドに対してどの情報を抽出する必要があるかについての指示を入力する必要があります。最大 1000 文字を入力できます。応答 (抽出結果) は「コンプリーション」とも呼ばれ、700 単語に制限されています。つまり、1 つのプロンプトあたりの抽出結果が 700 単語を超えることはできません。抽出要件がこの制限を超える場合は、ドキュメントを複数のページに分割して個別に処理し、後で結果を結合できます。
ヒント: 生成 AI のプロンプトの使用方法に関する効果的な実践については、「生成 AI 抽出器 - 効果的な実践」ページをご覧ください。
バージョンまたはタグ - 既存の Document Understanding モダンプロジェクトを使用する場合は、このプロパティを使用します。データを処理するプロジェクトのバージョンに対応するタグを選択します。たとえば、バージョン 3 に割り当てられた [運用] タグを選択すると、運用環境にあるプロジェクトのバージョン 3 のデータが処理されます。
[バージョン] の既定値は [ステージング] です。選択したプロジェクトに [ステージング] タグが存在しない場合、既定値は [運用] になります。

バージョンについて詳しくは、「モデルをパブリッシュする」をご覧ください。
ドキュメントの種類 - [バージョン] フィールドからタグを選択すると、選択したプロジェクトの関連バージョンから、最初にデプロイされたドキュメントの種類が自動的に選択されます。さらに、選択したドキュメントの種類に関連する抽出フィールドも表示されます。

プロパティパネル

入力

タイムアウト (秒) - 生成 AI モデルへの呼び出しの最大実行時間 (秒単位) です。このタイムアウト値を超えると、遅延やハングを防ぐために操作が自動的に終了されます。このプロパティは、[生成 AI 抽出器] が抽出器として選択されている場合にのみ表示されます。
自動検証 - 自動検証を有効化する場合に使用します。データ抽出で得られた結果を生成モデルに対して検証する場合に便利な機能です。[自動検証] フィールドの既定値は False です。
- 信頼度のしきい値 - [自動検証] を有効化すると表示されます。しきい値を下回る抽出結果は、生成 AI による抽出モデルの結果と比較されます。結果が同じ場合、抽出結果の信頼度の値はしきい値に合わせて調整されます。指定可能なしきい値の範囲は 0 から 100 です。
  値を 0 に設定すると、検証は適用されません。ただし、特定の値 (0 から 100) を設定すると、その値を下回るすべての抽出結果がチェックされます。たとえば、信頼度のしきい値を 80% に設定すると、信頼度が 80% を下回るフィールドに生成 AI による検証が適用されます。
  
  注: 自動検証は、専用の抽出モデルでのみ利用できます。
データ型を生成 - True に設定すると、選択した抽出器に基づいて出力が生成され、IDocumentData<ExtractorType> オブジェクトが生成されます。また、False に設定すると、データ生成をスキップして汎用 IDocumentData<DictionaryData> オブジェクトが生成されます。
2 つのオブジェクトの種類の詳細と制限については、「ドキュメントデータ」をご覧ください。

出力

ドキュメントデータ - ファイルから抽出されるすべてのフィールドデータです。情報は、[ドキュメントを分類] アクティビティから受け取ることもできます。
ドキュメントデータの仕組み、および単一値フィールドと複数値フィールドで抽出結果を使用する方法については、「ドキュメントデータ」をご覧ください。

設計時の外部接続

設計時の外部接続を使用すると、他のプロジェクトまたはテナントの Document Understanding のリソースを使用してアクティビティを活用できます。これらのプロパティを設定する前に、「実行時の外部接続を設定する」のページに記載された前提条件を満たしていることを確認してください。これらの手順が完了したら、実行時の外部接続の設定に進むことができます。

アプリ ID: 作成済みの外部アプリケーションのアプリ ID を入力します。
アプリシークレット: 作成済みの外部アプリケーションのアプリシークレットを入力します。
テナント URL: 外部アプリケーションを作成したテナントの URL を入力します。これは、設計時に使用するリソースが存在するテナントです。
URL の形式は https://<baseURL>/<OrganizationName>/<TenantName> です。

実行時の外部接続

実行時の外部接続を使用すると、オンプレミスのロボットを介してアクティビティを実行できます。これらのプロパティを設定する前に、「実行時の外部接続を設定する」のページに記載された前提条件を満たしていることを確認してください。これらの手順が完了したら、実行時の外部接続の設定に進むことができます。

実行時の資格情報アセット - このフィールドは、ロボットがローカルの Orchestrator に接続されているとき、または別のテナントから接続されているときに、Document Understanding のリソースにアクセスする必要がある場合に使用します。認証のための資格情報アセットは、次のいずれかの方法で入力できます。
- ドロップダウンリストから、UiPath® Robot が接続されている Orchestrator の目的の資格情報アセットを選択します。
- プロジェクトにアクセスするための外部アプリケーションの資格情報を保存する Orchestrator 資格情報アセットへのパスを手動で入力します。
  パスの形式は、<OrchestratorFolderName>/<AssetName> のようになります。
実行時のテナント URL - このフィールドは、[実行時の資格情報アセット] フィールドとともに使用します。抽出を実行するためにロボットが接続するテナントの URL を入力します。URL の形式は、https://<baseURL>/<OrganizationName>/<TenantName> です。

対応機種

Generative Predefined プロジェクトで利用可能な生成 AI 抽出器は、以下の表に示すドキュメントに使用できます。

注: 現在、Automation Cloud^TM (公共部門向け) 環境 (FedRamp) では、Long Document Complex Layout 抽出器と Short Document Complex Layout 抽出器は利用できません。

表 1. 生成 AI 抽出器でサポートされるシナリオ
抽出器	推奨シナリオ	プロバイダー	利用可能なリージョン
Long Document Simple Layout Extractor	主にテキストと見出しで構成される長文のドキュメントにお勧めします。たとえば、賃貸契約書、マスターサービス契約などのドキュメントに使用できます。	Azure OpenAI	英国、オーストラリア、インド、カナダ
Long Document Complex Layout Extractor	画像、手書き文字、フォーム要素などの複雑なレイアウトや、フローティング吹き出しボックスなどの特徴的なレイアウトを含む長文のドキュメントにお勧めします。保険証券など、一般的に複雑なレイアウトを持つ長文のドキュメントに使用できます。	Azure OpenAI	米国、欧州連合、日本、シンガポール
Short Document Complex Layout Extractor	画像、手書き文字、フォーム要素や、フローティング吹き出しボックスなどの複雑なレイアウトを含む短いドキュメント (最大 20 ページ) にお勧めします。政府発行の ID や医療の問診票など、一般的に短いものの複雑なレイアウトを持つドキュメントに使用できます。	Azure OpenAI	米国、欧州連合、日本、シンガポール

¹ マルチモーダルのサポートとは、テキスト、画像、手書き文字などの複数の種類のデータ入力を抽出できることを指します。

生成 AI 抽出器を使用する

[ドキュメントデータを抽出] アクティビティの生成機能をすぐに使用するには、以下の手順を実行してください。

[ドキュメントデータを抽出] アクティビティを追加します。
[プロジェクト] ドロップダウンリストから [Generative Predefined] を選択します。
[抽出器] で、[Long Document Simple Layout Extractor]、[Long Document Complex Layout Extractor]、[Short Document Complex Layout Extractor] のいずれかの抽出器を選択します。
[ドキュメントの種類の詳細] プロパティがアクティビティの本体に表示されます。

[ディクショナリ] に、指示をディクショナリのキーと値のペアとして入力します。各要素は次のように指定します。

[フィールド名] は、ドキュメントから抽出するフィールドの名前を表します。例: email address
[指示] は、フィールドを抽出するためにどのような情報を抽出器に与えるかについての指示を表します。これは、対応する値を識別するために生成 AI 抽出器が使用する説明です。
以下の表に、キーと値のペアのサンプルをいくつか示してありますので、確認してください。