Document Understanding のコード化されたオートメーション API (プレビュー)

Document Understanding アクティビティ パッケージ用のコード化されたオートメーション API です。ドキュメントの分類、データ抽出、検証成果物に対応します。

UiPath.DocumentUnderstanding.Activities

ドキュメントの分類、構造化データの抽出、ドキュメント検証成果物の作成と取得のためのコード化されたワークフロー API です。これらの API は、コード化されたオートメーションを設計する際に使用できます。コード化されたオートメーションの概要と、API を使用してそれらのオートメーションを設計する方法については、「 コード化されたオートメーション」をご覧ください。

• サービス アクセサ: du ( IDocumentUnderstandingService型)
• 必要なパッケージ: 依存関係project.json"UiPath.DocumentUnderstanding.Activities": "*"。

自動インポートされる名前空間

Document Understanding パッケージをインストールすると、コード化されたワークフローで以下の名前空間が自動的に利用可能になります。

• UiPath.DocumentUnderstanding.Activities.Api
• UiPath.Platform.ResourceHandling
• UiPath.DocumentProcessing.Contracts.Actions
• UiPath.IntelligentOCR.StudioWeb.Activities.DataExtraction
• UiPath.IntelligentOCR.StudioWeb.Activities.DocumentClassification

サービスの概要

du サービスでは、Document Understanding の各操作が直接メソッド呼び出しとして公開されます。開くコネクションまたはスコープがありません。サービス アクセサーのメソッドを直接呼び出します。

var extracted = du.ExtractDocumentData(@"C:\invoices\invoice.pdf", "Invoices", "Production", "invoice");

このサービスは、Studio Web の [ドキュメントを分類]、[ ドキュメント データを抽出]、[ ドキュメント検証成果物を作成]、および [ ドキュメント検証成果物を取得 ] の各アクティビティをミラーリングします。

プロジェクトのバージョンまたはタグ

projectVersionOrTag パラメーターは、Studio の単一の [バージョン] ドロップダウンにマップされます。バージョン名 (例: v3) またはタグ (例: Production、 Staging、 live) を渡します。ランタイムは、プロジェクトに一致する種類を解決します。[Predefined] プロジェクトでは、 を使用します Production。

共通パラメーター

• timeoutMs (Int) - 分類と抽出のタイムアウト (ミリ秒単位)既定値は 3600000 (1 時間) です。
• docType (String) - ドキュメントの種類の ID です。複数のドキュメントの種類を含むプロジェクトにはドキュメントの種類名を渡します。バージョンごとに抽出器が 1 つである IXP スタイルのプロジェクトには空の文字列を渡します。

分類

DocumentData ClassifyDocument(string documentPath, string projectName, string projectVersionOrTag, int timeoutMs = 3600000)

ローカル ファイル パスのドキュメントを Document Understanding プロジェクトに分類します。予測されたドキュメントの種類を含む DocumentData オブジェクトを返します。

DocumentData ClassifyDocument(IResource file, string projectName, string projectVersionOrTag, int timeoutMs = 3600000)

指定されたドキュメント リソースを分類します。[パスの存在を確認] や [ローカル ファイル/フォルダーを取得] アクティビティの出力など、任意のIResourceを受け入れます。

データ抽出

IDocumentData<DictionaryData> ExtractDocumentData(string documentPath, string projectName, string projectVersionOrTag, string docType, int timeoutMs = 3600000)

ローカル ファイル パスにあるドキュメントから構造化データを抽出します。抽出されたフィールドは IDocumentData<DictionaryData>として返されます。

IDocumentData<DictionaryData> ExtractDocumentData(IResource file, string projectName, string projectVersionOrTag, string docType, int timeoutMs = 3600000)

指定されたドキュメント リソースから構造化データを抽出します。

IDocumentData<DictionaryData> ExtractDocumentData(DocumentData classifiedDocument, string projectName, string projectVersionOrTag, string docType = null, int timeoutMs = 3600000)

すでに ClassifyDocumentで分類されているドキュメントから構造化データを抽出します。これにより、ファイルが再デジタル化されないようになります。docType がnullの場合、分類されたドキュメントのドキュメントの種類から派生します。

検証の成果物

ContentValidationData CreateDocumentValidationArtifacts(IDocumentData<DictionaryData> automaticExtractionResults, string orchestratorFolderName, string orchestratorBucketName = null)

抽出結果を Orchestrator のストレージにアップロードし、 ContentValidationData ハンドルを返します。ハンドルを使用して検証アクションを作成するか、後で を使用して結果を取得する RetrieveDocumentValidationArtifactsを使用します。orchestratorBucketName が nullの場合、既定のバケットが使用されます。

IDocumentData<DictionaryData> RetrieveDocumentValidationArtifacts(ContentValidationData contentValidationData, object completedAppAction = null, bool removeDataFromStorage = false, bool returnAutomaticExtractionResults = false)

検証済みの抽出結果をストレージから取得します。removeDataFromStorage がtrueの場合、ストレージ成果物は取得後に削除されます。returnAutomaticExtractionResults がtrueの場合、検証済みの結果ではなく元の自動抽出結果が返されます。

アクティビティとの関係

コード化された API アクティビティと Document Understanding XAML アクティビティは同じランタイムで実行されるため、コード化されたワークフローは、[ ドキュメント データを抽出 ] アクティビティおよび [ ドキュメントを分類 ] アクティビティと同じ分類、抽出、検証成果物の動作になります。違いは呼び出しの形状です。このサービスはプレーンなファイル パスまたはIResource入力を受け取り、Document Data オブジェクトを直接返します。また、アクティビティの [エラー発生時に実行を継続] オプションの代わりに通常のtry/catchを使用します。

一般的なパターン

分類してから抽出

このパターンでは、ドキュメントを分類し、分類された結果を再利用してデータを抽出するため、ファイルを 2 度目にデジタル化するのを回避できます。

[Workflow]
public void Execute()
{
    var classified = du.ClassifyDocument(@"C:\docs\file.pdf", "MyProject", "Production");
    Log($"Document type: {classified.DocumentType.DisplayName}");

    // Reuses the classified document, so the file is not digitized again.
    var extracted = du.ExtractDocumentData(classified, "MyProject", "Production");
}

検証コントロールを含むアプリ タスクのデータを抽出して準備する

このパターンは、データを抽出し、アプリ タスクで確認するために検証成果物としてストレージにアップロードし、アクションの完了後に検証済みの結果を取得します。

[Workflow]
public void Execute()
{
    var extracted = du.ExtractDocumentData(@"C:\docs\invoice.pdf", "Invoices", "Production", "invoice");

    // Upload the results so they can be reviewed in Action Center.
    var artifacts = du.CreateDocumentValidationArtifacts(extracted, "Shared");

    // After the Action Center validation action completes, retrieve the validated results.
    var validated = du.RetrieveDocumentValidationArtifacts(artifacts, removeDataFromStorage: true);
}