Analyze Multipage Document

The Analyze Multipage Document activity uses the Amazon Textract StartDocumentAnalysis and GetDocumentAnalysis APIs to analyze a multi-page document stored in an S3 bucket (Bucket, DocumentName, and Version). If your document includes a table, you have the option to indicate if the first row contains column headers (DiscoverColumnHeaders) and/or ignore empty rows (IgnoreEmptyRows).

ドキュメントの分析後、アクティビティはドキュメントのプロパティを PageDetailCollection オブジェクト (ページ) に返します。このオブジェクトは、Amazon Textract アクティビティ パッケージ以外の他のアクティビティの入力変数として使用できます。

[ 複数ページのドキュメントを分析 ] アクティビティは、基本的に、[ ドキュメントの分析を開始]、[ ドキュメント分析のステータスを取得]、および [ドキュメント分析を取得 ] アクティビティを 1 つのアクティビティにまとめたものです。

重要:

このアクティビティの以前のバージョンでは、(Pages) 出力パラメーターは PageDetail[] オブジェクトを返していました。2.0では、これは PageDetailCollection に変更され、配列では不可能だったメソッド呼び出しのRawJsonプロパティを返すことができます。

動作のしくみ

次の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入出力プロパティ) から実行時までのアクティビティの動作の例です。

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [Amazon スコープ ] アクティビティを追加します。
3. [ 単一ページのドキュメントを分析 ] を [Amazon スコープ ] アクティビティ内に追加します。
4. [S3 ストレージ] 入力プロパティに値を入力します。
5. [出力] セクションのプロパティのために PageDetailCollection 型変数を作成し、入力します。
6. アクティビティを実行します。

   • 入力したプロパティは、 AnalyzeDocument API に渡されます。

   • API は、[出力] セクションのプロパティ変数に PageDetail の値を返します。

     

プロパティ

以下のプロパティの値は、このアクティビティを UiPath Studio でプロジェクトに追加するときに指定します。

共通

表示名

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

属性	詳細
入力	String
Required	はい
既定値	Analyze Multipage Document
許容値	String または String 型変数を入力します。
備考	N/A

入力

[ ドキュメント分析ステータスを取得] では、サービスのステータス変更をポーリングするために外部遅延メカニズムが必要ですが、[複数ページのドキュメントを分析] には、初期ステータス チェックの遅延 ([InitialDelay]) とステータス チェック間隔 ([StatusCheckInterval]) を設定するための、次のオプションの入力プロパティがあります。

InitialDelay

アクティビティが Amazon Textract GetDocumentAnalysis API を呼び出して JobStatus の値を取得するまでの待機時間です。

属性	詳細
入力	Int32 (ミリ秒)
Required	いいえ
既定値	15000 (表示されません)
許容値	Int32 または Int32 型変数を入力します。
備考	値をミリ秒単位で入力します (例: 30 秒間で 30000 )。値は 15000 以上である必要があります。大きなドキュメントを分析する場合は、Amazon Textract サービスが分析を完了するのに要する推定時間を入力することをお勧めします。たとえば、ドキュメントの分析に最大 2 分かかる場合は、値として「120000」と入力し、 StatusCheckInterval プロパティを使用して、ジョブが 2 分以内に完了しない場合にステータスが更新されたかどうかを確認する頻度を指定する必要があります。

StatusCheckInterval

Amazon Textract GetDocumentAnalysis API への呼び出しの間にジョブステータスの値を取得するまでに待機する時間です。

属性	詳細
入力	Int32 (ミリ秒)
Required	いいえ
既定値	10000 (表示されません)
許容値	Int32 または Int32 型変数を入力します。
備考	値をミリ秒単位で入力します (例: 30 秒間で 15000 )。値は 10000 以上である必要があります。このプロパティの目的は、アクティビティが Amazon Textract API に対して行う呼び出しの数を管理するのに役立ちます。

オプション

分析の種類

実行する分析の種類を指定します。 [表] を使用して、入力ドキュメントで検出されたテーブルに関する情報を返し、検出されたフォーム データを返すフォームを使用します。

属性	詳細
入力	ENUM
Required	No.
既定値	すべて
許容値	すべて、表、フォーム
備考	N/A

DiscoverColumnHeaders

ドキュメントのテーブルに列ヘッダーを含めるかどうかを指定します。

属性	詳細
入力	チェックボックス
Required	いいえ
既定値	非選択
許容値	選択または非選択
備考	N/A

空の行を無視

ドキュメントの分析時に、ドキュメントの表内の空の行を無視するかどうかを指定します。

属性	詳細
入力	チェックボックス
Required	いいえ
既定値	非選択
許容値	選択または非選択
備考	N/A

S3 ストレージ

バケット

ドキュメントが保存される S3 バケットの名前です。

属性	詳細
入力	String
Required	はい
既定値	空
許容値	String または String 型変数を入力します。
備考	ドキュメントを含む S3 バケットの AWS リージョンは、[Amazon スコープ] アクティビティで選択したリージョンと一致する必要があります。Amazon Textract が S3 バケット内のファイルを処理するには、ユーザーに S3 バケットへのアクセス許可が必要です。詳細については、「セットアップ」ガイドの「IAM ユーザーの作成」セクションのステップ 6 をご覧ください。

DocumentName

The case-sensitive name of the file in the specified Bucket that you want to analyze.

属性	詳細
入力	String
Required	はい
既定値	空
許容値	String または String 型変数を入力します。
備考	サポートされているドキュメントの形式 ( PNG、JPEG、PDF)

バージョン

バケットでバージョン管理が有効化されている場合は、オブジェクトのバージョンを指定できます。

属性	詳細
入力	String
Required	いいえ
既定値	空
許容値	String または String 型変数を入力します。
備考	N/A

その他

プライベート (Private)

選択すると、変数と引数の値が Verbose レベルでログ記録されなくなります。

属性	詳細
入力	チェックボックス
Required	いいえ
既定値	非選択
許容値	選択または非選択
備考	N/A

出力

ページ数

指定したドキュメントから抽出されたプロパティが配列として返されます。

属性	詳細
入力	PageDetailCollection
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	PageDetailCollection 型変数を入力します。
備考	Each object from the array represents the results for one individual page. This is a change from previous versions which returned a PageDetail[] object. See Page Detail for the description of the PageDetail object and its properties.

例

次の画像は、アクティビティの依存関係と入力/出力プロパティの値の例です。

ステップバイステップの手順および例は、「クイックスタート」ページをご覧ください。