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

[ドキュメント データを抽出] アクティビティを使用してドキュメント ファイルまたは Document Data オブジェクトからデータを抽出し、結果を Document Data オブジェクトに格納します。

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 でサポートされている言語」をご覧ください。

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

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

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

既知の制限事項

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

[ドキュメント データを抽出] アクティビティを使用する場合、分類フィールドはモダン プロジェクトの抽出器とすぐに使えるモデルではサポートされますが、クラシック プロジェクトの抽出器ではサポートされません。

[ドキュメント データを抽出] アクティビティにサブドキュメントを含むドキュメント データを指定すると、ランタイム エラーが発生します。この動作は仕様です。分割されたドキュメントからデータを抽出するには、各サブドキュメントを反復処理します。

プロジェクトの対応 OS

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

構成

デザイナー パネル

• 入力ファイル - ファイル自体、またはワークフローで他の「Document Understanding」系アクティビティ ([ドキュメントを分類] など) を使用している場合はそのドキュメント データを指定する必要があります。

  重要:

  1 つのファイルに含めることができる最大ページ数は 500 です。この制限を超えるファイルは抽出できません。

• プロジェクト - ドロップダウン リストからお使いの Document Understanding プロジェクトを選択する必要があります。利用可能なオプションは次のとおりです。

  • Predefined – 標準的なシナリオに推奨される、事前トレーニング済みの専門家されたモデルを使用するクラシック プロジェクトの種類です。 クラシック プロジェクトの請求ロジックについて詳しくは、「使用状況の測定と請求ロジック」をご覧ください。
  • Generative Predefined - 事前トレーニング済みの生成 AI モデルを使用するモダン プロジェクトの種類です。ドキュメント データを抽出するための入力として指示を入力できます。 モダン プロジェクトの請求ロジックについて詳しくは、「使用状況の測定と請求ロジック」をご覧ください。
  • Predefined Non-Latin Languages – ラテン語以外のドキュメントを処理するシナリオに事前トレーニング済みのモデルを使用するモダン プロジェクトの種類です。 モダン プロジェクトの請求ロジックについて詳しくは、「使用状況の測定と請求ロジック」をご覧ください。
  • 接続先のテナントおよびフォルダーにある既存のプロジェクト。
  • カスタム プロジェクトは、Document Understanding に移動して作成できます。 詳しくは、モデルの構築の概要をご覧ください。
    注:

    テナントに 500 を超えるプロジェクトを作成し、[ドキュメント データを抽出] アクティビティを使用した場合、UiPath Studio または Studio Web には、最初の 500 を超えるプロジェクトは表示されません。したがって、これらのプロジェクトは使用できません。

• 抽出器 - プロジェクトを選択した後に、使用する抽出器を選択することもできます。

  • [Predefined] プロジェクトの場合、次の 2 つの選択肢があります。 - 事前トレーニング済みのモデルを選択します。使用可能な事前トレーニング済みモデルのリストについては 、「すぐに使えるモデル 」をご覧ください。
    注:

    [ドキュメント データを抽出] アクティビティは、選択した抽出器のドキュメントの種類で利用可能なフィールドの情報を抽出します (ドキュメントの実際の種類は関係ありません)。これは、生成モデルには適用されません。

    • [Generative Extractor] を選択します。
      注:

      生成 AI 抽出器に送信された情報は、LLM モデル インスタンスに送られます。このインスタンスは公開されておらず、送信されたデータは保存されることもトレーニング目的で使用されることもありません。

  • [Generative Predefined] プロジェクトには抽出の選択肢が 3 つあり、それぞれ以下の特定のドキュメント レイアウトに合わせて調整されています。
    • Long Document Simple Layout Extractor - 主にテキストと見出しで構成される長文のドキュメントにお勧めです。たとえば、賃貸契約書、マスター サービス契約などのドキュメントに使用できます。
    • Long Document Complex Layout Extractor (プレビュー) – 画像、手書き文字、フォーム コントロール、フローティング吹き出しボックス、またはその他の複雑なレイアウトの種類などの要素を含む長文のドキュメントにお勧めです。たとえば、保険証券などのドキュメントに使用できます。
    • Short Document Complex Layout Extractor (プレビュー) – 画像、手書き文字、フォーム コントロール、フローティング吹き出しボックス、またはその他の複雑なレイアウトの種類などの要素を含む短いドキュメントにお勧めです。たとえば、政府発行の ID、医療の問診票などのドキュメントに使用できます。
  • [Predefined Non-Latin Languages] プロジェクトには抽出の選択肢が 3 つあり、それぞれラテン語以外の以下の特定のドキュメント レイアウトに合わせて調整されています。
    • Invoices Japan (請求書 - 日本) – 日本の請求書ドキュメントに推奨されます。この抽出器は、日本の一般的な請求書レイアウトを処理することができ、サプライヤー情報、請求書番号、通貨などの主要な請求書フィールドを識別して抽出できます。
    • Invoices China (請求書 - 中国) - 中国の請求書ドキュメントに推奨されます。この抽出器は、中国の一般的な請求書レイアウトを処理することができ、サプライヤー情報、請求書番号、通貨などの主要な請求書フィールドを識別して抽出できます。
    • Receipts Japan (領収書 - 日本) - 日本の領収書ドキュメントに推奨されます。この抽出器を使用すると、日本語の領収書から販売店名、取引日、合計金額、税額、通貨などのフィールドを識別して抽出できます。
  • 分類結果を使用: [データ型を生成] プロパティが false に設定されている場合、[分類結果を使用] オプションを選択できます。このオプションを選択すると、[ドキュメントを分類] アクティビティの結果として生成されるドキュメントの種類に基づいて、推奨される抽出器が自動的に使用されます。 そのドキュメントの種類を処理できる抽出器が複数ある場合は、エラーが返されます。このシナリオでは、使用する抽出器を手動で選択する必要があります。

• ドキュメントの種類の詳細 - [Generative] オプションを選択した場合に表示されます。抽出対象のフィールドを識別するためのプロンプトです。キーと値のペアとして指定します。キーはフィールドの名前を、値はフィールドの説明を表します。抽出器が対象値を識別するのに役立ちます。このフィールドを選択すると、次のオプションがペアになったプロンプトが表示されます。

  • フィールド名 - 抽出するフィールド名 (例: 期限) を入力する必要があります (最大 30 文字)。
  • 指示 - 対応するフィールドに対してどの情報を抽出する必要があるかについての指示を入力する必要があります。最大 1000 文字を入力できます。応答 (抽出結果) は 「コンプリーション」とも呼ばれ、700 単語に制限されています。つまり、1 つのプロンプトあたりの抽出結果が 700 単語を超えることはできません。抽出要件がこの制限を超える場合は、ドキュメントを複数のページに分割して個別に処理し、後で結果を結合できます。
    ヒント:

    生成 AI のプロンプトの使用方法に関する効果的な実践については、「 生成 AI 抽出器 - 効果的な実践 」ページをご覧ください。

• バージョン - 既存の Document Understanding モダン プロジェクトを使用する場合は、このプロパティを使用します。データを処理するプロジェクトのバージョンに対応するバージョン名またはタグを選択します。たとえば、バージョン 3 に割り当てられた [ 運用 ] タグを選択すると、運用環境にあるプロジェクトのバージョン 3 のデータが処理されます。ステージング タグと運用タグを使用しない場合は、ドロップダウンから特定のバージョンを選択することもできます。バージョンについて詳しくは、「 モデルをパブリッシュする」をご覧ください。

• ドキュメントの種類 - [バージョン] フィールドからタグを選択すると、選択したプロジェクトの関連バージョンから、最初にデプロイされたドキュメントの種類が自動的に選択されます。さらに、選択したドキュメントの種類に関連する抽出フィールドも表示されます。

• Use Solution Resource - Enable this toggle to select an IXP model as a solution resource. This option is available only when your workflow is part of a solution. The selected IXP model is added to the solution, appears in the Resource Explorer in Studio Web, and is packaged and deployed together with the rest of the solution's resources.

  • IXP Model - Select the IXP model that you want to use for data extraction. This field appears only when you enable the Use Solution Resource toggle.

プロパティ パネル

入力

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

    自動検証は、専用の抽出モデルでのみ利用できます。

• Generate Data Type - If set to True, indicates that the output should be generated based on the selected extractor, resulting in an IDocumentData<ExtractorType> object. Alternatively, if set to False, indicates that the data generation should be skipped, resulting in a generic IDocumentData<DictionaryData> object. When set to False, you can consume the results either through the Get/Set methods or through the strongly-typed ExtractionResultHandler navigator, available on the output as DocumentData.Data.Handler. Visit Document Data for additional details and limitations available for the two object types.

出力

• Document Data - All the extracted field data from the file. Information can also be received from Classify Document. To learn how Document Data works and how to consume the extracted results for single and multi-value fields, visit Document data. When Generate Data Type is off, the DictionaryData output can also be navigated and edited with the strongly-typed ExtractionResultHandler navigator, via DocumentData.Data.Handler.

  IXP 非構造化ドキュメント プロジェクトを [ドキュメント データを抽出] アクティビティと一緒に使用する場合、[ドキュメント データ] 出力オブジェクトは以下をサポートします。

  • 結果は、テーブルではなくフィールド グループとして報告されます。
  • フィールドは、 金額など、プロジェクトで定義されている特定のフィールドの種類を返します。
  • ドキュメント検証タスクでは、結果が表ではなくフィールド グループとして表示されます。

  この出力に依存するダウンストリーム処理やデータ操作ロジックでは、 フィールド グループ の値を考慮する必要があります。サポートされているフィールドの種類の完全なリストについては、「 FieldType Enum」をご覧ください。

外部接続

• 資格情報アセット - Document Understanding テナントに対する認証に使用される Orchestrator 資格情報アセットのパスです。入力では、 <orchestratorFolder>/<assetName>の形式を使用する必要があります。
• テナント URL - Document Understanding サービスに対する認証に使用されるテナント URL です。入力では、 https://<base_url>/<organization>/<tenant>の形式を使用する必要があります。

注:

資格情報アセットは、[ アクセス スコープ] → [オートメーションと API] で設定する必要があります。別のテナントまたは組織に対する認証は、この資格情報アセット構成がサポートされている環境でのみ機能します。

対応機種

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

注:

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

表 1.生成 AI 抽出器でサポートされるシナリオ

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

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

生成 AI 抽出器を使用する

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

1. [ドキュメント データを抽出] アクティビティを追加します。
2. [プロジェクト] ドロップダウン リストから [Generative Predefined] を選択します。
3. [抽出器] で、[Long Document Simple Layout Extractor]、[Long Document Complex Layout Extractor]、[Short Document Complex Layout Extractor] のいずれかの抽出器を選択します。 [ドキュメントの種類の詳細] プロパティがアクティビティの本体に表示されます。
4. [ディクショナリ] に、指示をディクショナリのキーと値のペアとして入力します。各要素は次のように指定します。

   • [フィールド名] は、ドキュメントから抽出するフィールドの名前を表します。たとえば、email addressのようになります。

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

     表 2. 生成 AI 抽出器のプロンプトのキーと値のペアの例

     フィールド名	指示
     名前	候補者の名前は何ですか?
     現在の仕事	候補者の名前は何ですか?
     雇用主	候補者の現在の雇用主は何ですか?

     図 1.生成 AI 抽出器のキーと値のペアの詳細