- 概要
- モデルの構築
- モデルの検証
- モデルのデプロイ
- 概要
- モデル バージョンをパブリッシュする
- パブリッシュ済みのバージョンを管理する
- ワークフローを構築して使用する
- CLI
- API
- よくある質問

非構造化ドキュメントと複雑なドキュメント ユーザー ガイド
ワークフローを構築して使用する
UiPath Studio でワークフローを構築することにより、非構造化ドキュメントと複雑なドキュメントのパブリッシュ済みのモデル バージョンの予測を使用できます。
概要
IXP の非構造化ドキュメントと複雑なドキュメントのワークフローを構築するには、一般的に以下の手順が必要です。
- パッケージのインストール
- タクソノミーの定義
- ドキュメントのデジタル化
- ドキュメント分類
- ドキュメントの抽出
- ドキュメント検証
タクソノミーの定義の手順は Windows プロジェクトにのみ適用され、クロスプラットフォーム プロジェクトには適用されません。プロジェクトの種類の違いについては、以降のセクションをご覧ください。
前提条件
非構造化ドキュメントと複雑なドキュメント プロジェクトにモデルをパブリッシュしている必要があります。
Studio のワークフローの構築を開始する際に、実行するプロジェクトの種類 ([Windows] または [クロスプラットフォーム]) を決定する必要があります。プロジェクトの種類ごとに異なるパッケージが必要です。
選択するプロジェクトの種類にかかわらず、以下の方法でパッケージをインストールできます。
- 自動 - Document Understanding Process テンプレートを使用します。Studio でテンプレートを検索およびインストールする方法について詳しくは、「プロジェクト テンプレート」をご覧ください。
- 手動 - 詳しくは、「パッケージをインストールする」をご覧ください。パッケージを手動でインストールする場合は、プロジェクトの種類に基づいて、以下のバージョン以降をインストールします。
Windows
- UiPath.IntelligentOCR.Activities 6.22.0
- UiPath.System.Activities 24.10.6
クロスプラットフォーム
- UiPath.DocumentUnderstanding.Activities 2.12.0
- UiPath.System.Activities 24.10.6
- IntelligentOCR パッケージは Windows プロジェクトに対応しています。クロスプラットフォーム プロジェクトには対応していません。
- Studio Web では、クロスプラットフォーム ワークフローを構築したり、他のテンプレートを使用したりできます。
Windows プロジェクト用の IXP ワークフローを構築する
以降の各セクションでは、Studio のテンプレートを一切使用せず、一から作成する場合に適用する手順を示します。
Windows プロジェクト用の IXP ワークフローを構築するには、以下の手順を実行します。
次の各セクションで使用する変数名は例に過ぎません。変数には、独自の規則に従って名前を割り当てることができます。
1. パッケージをインストールする
「前提条件」セクションに記載されているパッケージを必ずインストールします。
2. タクソノミーを定義する
-
デスクトップ版の Studio で基本のプロセスを作成します。
-
プロセスを設定する際に、[対応 OS] フィールドで、構築するワークフローの種類として [Windows] または [クロスプラットフォーム] を選択します。詳しくは、「オートメーション プロジェクトについて」をご覧ください。
-
[デザイン] タブからタクソノミー マネージャーを開き、表の各フィールドを次のように設定します。
- IXP プロジェクトのタクソノミーに含まれるすべてのフィールド グループに対して表フィールドを作成します。
- フィールド グループで定義された各フィールドに対して、それぞれの表フィールドに列を追加します。
注:タクソノミー マネージャーの特徴:
- 表とフィールドの作成がサポートされています。IXP 非構造化ドキュメントと複雑なドキュメントのワークフローを作成する場合は、単なるフィールドではなく表フィールドを作成することをお勧めします。
- Intelligent OCR パッケージがインストールされている場合にのみ利用できます。つまり、クロスプラットフォームではなく Windows プロジェクトでのみ利用できます。
-
つづいて、ドキュメントの読み取り先とすることができる場所が必要です。たとえば、名前を documents とした新しいフォルダーをプロジェクト フォルダーに作成し、そこにいくつかのファイルを追加します。
-
[シーケンス] に [代入] アクティビティを追加して、どこからドキュメントを読み込むかを指定します。次の各フィールドを設定します。
- 保存先 - System.String[] 型の変数を作成して追加します。以下の例では、変数名を docs としています。
- 保存する値 -
Directory.GetFiles("./documents")を追加します。
![[代入] アクティビティ](https://dev-assets.cms.uipath.com/assets/images/ixp/UCD_The_Assign_Activity-b76886e8.png)
-
設定したタクソノミーを変数に格納し、オートメーションの他の部分で参照できるようにするために、[タクソノミーを読み込み] アクティビティを追加します。DocumentTaxonomy 型の変数を作成して追加します。この例では、この変数を taxo としています。
注:この変数をアクティビティの出力にマップする必要があります。
![[タクソノミーを読み込み] アクティビティ](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-load-taxonomy-activity-632128-c2ce95db.webp)
3. ドキュメントをデジタル化する
-
各ドキュメントを処理するために、[繰り返し (コレクションの各要素)] アクティビティを追加します。入力には、先ほど作成した docs 変数を追加します。
![[繰り返し (コレクションの各要素)] アクティビティ](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-for-each-activity-632156-a794867c.webp)
-
[繰り返し (コレクションの各要素)] に次のアクティビティをドラッグ アンド ドロップします。
- ドキュメントをデジタル化 - 指定したドキュメントを読み取って、ドキュメント オブジェクト モデル (DOM) の出力を取得できます。次の各フィールドを設定します。
-
ドキュメント パス - doc 変数を追加します。この変数は、[繰り返し (コレクションの各要素)] アクティビティで設定した [アイテム名] にあります。この例では、デジタル化するドキュメントのファイル パスを表す doc がアイテム名です。
-
ドキュメント テキスト - text 変数を作成して追加します。
-
ドキュメント オブジェクト モデル (DOM) - dom 変数を作成して追加します。
![[ドキュメントをデジタル化] アクティビティ](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-digitize-document-activity-632151-28366f19.webp)
-
- ドキュメントをデジタル化 - 指定したドキュメントを読み取って、ドキュメント オブジェクト モデル (DOM) の出力を取得できます。次の各フィールドを設定します。
4. ドキュメントを分類する
同じ [繰り返し (コレクションの各要素)] アクティビティの中で、[ドキュメントをデジタル化] の後に次のアクティビティをドラッグ アンド ドロップします。
- ドキュメント分類スコープ - 処理中のドキュメントを、タクソノミーで定義されているドキュメントの種類のいずれかに分類できます。入力には以下を追加します。
-
ドキュメント パス - doc 変数を追加します。
-
ドキュメントのテキスト - text 変数を追加します。
-
ドキュメント オブジェクト モデル (DOM) - dom 変数を追加します。
-
タクソノミー - taxo 変数を追加します。出力として以下を追加します。
-
分類結果 - 新しい変数 ClassificationResults を作成して追加します。
![[ドキュメント分類スコープ] アクティビティ](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-classify-document-scope-activity-637454-0abdc1c1.webp)
-
[ドキュメント分類スコープ] で [生成 AI 分類器] アクティビティを追加し、生成モデルを使用してドキュメントを分類します。このアクティビティを以下の手順で設定します。1. [フィールドの詳細を管理] を選択します。2. [ドキュメントの種類] 列でドキュメントの種類を選択します。3. [フィールドの詳細] 列で、任意の値を追加してドキュメントの種類に関する追加の詳細を定義します。ドキュメントの種類の簡単な説明を指定できます。最大 1000 文字を入力できます。4. [保存] を選択します。
![[生成 AI 分類器] アクティビティ。](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-generative-classifier-activity-637450-11f73c5f.webp)
タクソノミーにあるドキュメントの種類が 1 つのみの場合、分類アクティビティの指定は任意です。ドキュメントの種類の ID をコピーして、それを [データ抽出スコープ] アクティビティへの入力として使用できます。
5. ドキュメントから詳細を抽出する
-
[繰り返し (コレクションの各要素)] に次のアクティビティをドラッグ アンド ドロップします。
- データ抽出スコープ - 抽出器アクティビティを設定できます。入力には以下を追加します。
- ドキュメント パス – doc 変数を追加します。
- ドキュメント テキスト – text 変数を追加します。
- ドキュメント オブジェクト モデル (DOM) – dom 変数を追加します。
- タクソノミー – taxo 変数を追加します。
- 分類結果 – ClassificationResults 変数を追加します。出力として以下を追加します。
- 抽出結果 – 新しい変数 ExtractionResults を作成して追加します。
- データ抽出スコープ - 抽出器アクティビティを設定できます。入力には以下を追加します。
-
[データ抽出スコープ] で、ドキュメント データを抽出する [Document Understanding プロジェクト抽出器] アクティビティを追加します。
![[データ抽出スコープ] アクティビティ](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-data-extraction-scope-activity-632164-23654c55.webp)
スコープにプロジェクト抽出器アクティビティを追加すると、[機能を取得] 設定ウィンドウが自動的に開きます。

-
パブリッシュしたプロジェクトが別の組織やテナントでホストされている場合、またはハイブリッド設定で使用されている場合は、次のように必要な詳細情報を [機能を取得] に追加します。
-
Automation Cloud の [管理] ページで外部アプリケーションを作成します。詳しくは、「外部アプリケーションを追加する」をご覧ください。
-
アプリ ID とアプリ シークレット (パスワード) をコピーします。
-
[機能を取得] ウィンドウで、資格情報、アプリケーション ID、シークレットを追加します。
-
「Document Understanding プロジェクト抽出器」の説明に従い、残りのフィールドを設定します。
注:テナント URL をコピーするときは、そこに組織名とテナント名が記述されていることを確認します。たとえば、
https://staging.uipath.com/communicationsminingteam/IXPTestingのような URL とします。communicationsminingteamは組織、IXPTestingはテナントです。 -
[Document Understanding プロジェクト抽出器] アクティビティで、[Document Understanding プロジェクト抽出器] アクティビティの [実行時の資格情報アセット] プロパティに、入力としてアセット パスを追加します。このパスは <OrchestratorFolderName>/<AssetName> の形式とする必要があります。
![[Document Understanding プロジェクト抽出器] の [実行時の資格情報アセット] プロパティ。](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-runtime-credentials-asset-property-of-the-document-understanding-project-extractor-634334-256defd3.webp)
-
-
プロジェクトがパブリッシュされた組織とテナントでワークフローを実行する場合は、[Document Understanding プロジェクト抽出器] アクティビティで、そのパブリッシュ済みプロジェクトを選択します。
注:Studio がモデルのパブリッシュ先と同じ組織またはテナントに接続されている場合は、そのパブリッシュされたモデルがドロップダウン オプションに表示されます。そのモデルが表示されない場合は、そのモデルが別の組織またはテナントにパブリッシュされていることが考えられます。この場合は、以降のセクション「クロス組織プロジェクト、クロステナント プロジェクト、またはハイブリッド プロジェクトから予測を使用する」の指示を適用します。
-
[抽出器を設定] を選択し、そのウィザードを使用して、非構造化ドキュメントと複雑なドキュメントのプロジェクトで定義したフィールドにタクソノミーのフィールドをマッピングします。図 1. Studio の [抽出器を設定] ウィザード
![この画像は、Studio の [抽出器を設定] ウィンドウを示しています。](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-image-shows-the-configure-extractors-window-in-studio-565434-457cccef.webp)
6. ドキュメントを検証する
必要に応じて、分類出力に人間による検証が必要かどうかを判断するための決定基準を設定できます。これは、カスタム ビジネス ルールまたは後処理ロジックを使用して実行できます。また、ワークフローでカスタムの決定基準を使用して検証をトリガーしたり、フィールド レベルの信頼度のしきい値を設定したりすることもできます。この決定基準は、業務プロセスの要件と、ユース ケースで許容される誤検知、つまり人間による検証をスキップしたが、誤って抽出された結果に対する条件となります。これらのルールに基づいて、ドキュメントを自動的に検証するか、それとも人間による検証に回すかを制御できます。詳しくは、「構造を確立する」の「検証の設定」をご覧ください。
-
検証ステーションで検証するために [検証ステーションを提示] アクティビティを追加します。[データ抽出スコープ] アクティビティの出力 ExtractionResults が、[検証ステーションを提示] アクティビティへの入力になります。入力には ExtractionResults 変数を追加します。出力には、新しい変数 ValidatedExtractionResults を作成して追加します。
-
入力には、以下を追加します。
- ドキュメント パス – doc 変数を追加します。
- ドキュメント テキスト – text 変数を追加します。
- ドキュメント オブジェクト モデル (DOM) – dom 変数を追加します。
- タクソノミー – taxo 変数を追加します。
- 自動抽出結果 – ExtractionResults 変数を追加します。
-
出力には、以下を追加します。
- 検証済みの抽出結果 – 新しい変数 ValidatedExtractionResults を作成して追加します。
![[検証ステーションを提示] アクティビティ](https://dev-assets.cms.uipath.com/assets/images/ixp/ixp-the-present-validation-station-activity-632170-ae03186c.webp)
この検証手順では、[検証ステーションを提示] 以外のアクティビティも使用できます。たとえば、次のとおりです。
- コンテンツの検証コンポーネントを使用するアプリがある場合は、[ドキュメント検証成果物を作成] または [アプリ タスクを作成]。
- 検証ステーションを Action Center に送信する場合は、[ドキュメント検証アクションを作成] または [ドキュメント検証アクション完了まで待機し再開]。
検証の詳細については、以下のリソースをご覧ください。
- 検証ステーション
- Apps (アプリ)
人間による検証をトリガーする
分類の出力の人間による検証をトリガーするには、分類手順の後に、ワークフローが抽出に進む前に判断ロジックを適用します。この判断は、既定では自動的には行われません。ワークフローで定義された信頼度のしきい値とビジネス ルールによって明示的に制御します。
人間による検証をトリガーする方法は以下のとおりです。
- 分類の信頼度の評価 各分類結果には、予測されたドキュメントの種類に関するモデルの信頼度を示す信頼度スコアが含まれます。これらのスコアをワークフローで評価して、分類が信頼できるかどうかを判断します。
- 信頼度のしきい値 分類の基準となる信頼度の最小しきい値を定義できます。予測されたドキュメントの種類に対する信頼度スコアがこのしきい値を下回ると、分類は不確実であると見なされ、そのドキュメントには、人間による検証が必要であることを示すフラグが付けられます。
- ビジネス ルールと条件ロジック 信頼度のしきい値のほか、次のようなカスタム ビジネス ルールを適用できます。
- 常に手動による確認が必要な特定のドキュメントの種類。
- 予期されたドキュメントの種類と予測されたドキュメントの種類の不一致。
- ドキュメントが後でどのように処理されるかに基づくルール。たとえば、抽出や承認の前に検証する必要があるドキュメントです。
- 検証手順をトリガーする 定義された基準が満たされると、ワークフローによっていずれかの検証メカニズムが呼び出され、ドキュメントが人間による検証ステップへルーティングされます。
- 検証ステーションを提示 - ロボット内で検証する場合
- 検証タスクを作成 - Action Center ベースで検証する場合
- ドキュメント検証成果物を作成 - Apps で検証する場合
- 人間による確認または修正 検証中に人間のレビュー担当者がドキュメントの種類を確認または修正します。検証済みの分類結果は、後続の手順 (データ抽出など) で使用され、承認されたドキュメントの種類に基づいてダウンストリーム処理が行われるようにします。結論として、人間による分類の検証は、ワークフローで制御されるルールによってトリガーされます。これは、通常は信頼度スコアとビジネス ロジックに基づきます。このルールにより、プロセスを続行する前に、どのような状況で分類結果を手動で確認する必要があるかが決まります。
IXP のモデルの検証ステーションの結果を解釈する
IXP の非構造化ドキュメントと複雑なドキュメントのモデルを活用するワークフローを使用する場合、検証ステーションは、抽出データをレビュー、確認、改良するための重要なインターフェイスとして機能します。検証ステーションには、モデルがドキュメントをどのように解釈したかが表示されるため、抽出の精度を理解して、不確実な領域を特定し、必要に応じて修正を行うことができます。
検証ステーションには、ドキュメントの種類とそれに対応するフィールドが、抽出された値および信頼度インジケーターとともに表示されます。 検証プロセスについて詳しくは、以下のリソースをご覧ください。
Windows プロジェクトのワークフローとクロスプラットフォーム プロジェクトのワークフローを比較する
以下の表に、Windows プロジェクトおよびクロスプラットフォーム プロジェクトの IXP ワークフローの比較を示します。
| Windows | クロスプラットフォーム | |
|---|---|---|
| 必要なパッケージ | IntelligentOCR | Document Understanding |
| タクソノミーを定義する | [タクソノミー マネージャー] オプションを使用して、検証ステーションに表示するフィールド、または抽出結果オブジェクトに含めるフィールドのリストを定義できます。 注: タクソノミー マネージャーは、Intelligent OCR パッケージがインストールされている場合にのみ利用できます。 | Document Understanding パッケージは、IXP モデルのスキーマで定義されているフィールドを自動的に読み取って表示します。これらのフィールドはワークフローでは設定されません。 |