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).

After analyzing the document, the activity returns the document properties in a PageDetailCollection object (Pages) that you can use as input variables in other activities outside of the Amazon Textract Activities Package.

The Analyze Multipage Document activity is essentially a combination of the Start Document Analysis, Get Document Analysis Status, and Get Document Analysis activities in a single activity.

重要:

In previous versions of this activity, the (Pages) output parameter returned a PageDetail[] object. In 2.0 this has been changed to a PageDetailCollection to allow us to return the RawJson property for the method call, which was not possible with an array.

動作のしくみ

The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.

1. 「セットアップ」の手順を完了します。
2. Add the Amazon Scope activity to your project.
3. Add the Analyze Single Page Document inside the Amazon Scope activity.
4. Enter values for the S3 Storage input properties.
5. Create and enter a PageDetailCollection variable for your Output property.
6. アクティビティを実行します。

   • Your input properties are sent to the AnalyzeDocument API.

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

     

プロパティ

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

共通

表示名

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

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

入力

Unlike the Get Document Analysis Status, which requires an external delay mechanism to poll the service for status changes, the Analyze Multipage Document includes the following, optional input properties to set an initial status check delay (InitialDelay) and status check interval (StatusCheckInterval).

InitialDelay

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

属性	詳細
入力	Int32 (ミリ秒)
Required	いいえ
既定値	15000 (not shown)
許容値	Int32 または Int32 型変数を入力します。
備考	Enter your value in milliseconds (e.g., 30000 for 30 seconds); your value must be greater or equal to 15000. When analyzing a large document, it's recommended that you enter the estimated time it takes for the Amazon Textract service to complete its analysis. For example, if your document takes up to 2 minutes to analyze, you should enter 120000 as your value and use the StatusCheckInterval property to indicate how often you want to check for an updated status if the job doesn't complete within the 2-minute estimate.

StatusCheckInterval

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

属性	詳細
入力	Int32 (ミリ秒)
Required	いいえ
既定値	10000 (not shown)
許容値	Int32 または Int32 型変数を入力します。
備考	Enter your value in milliseconds (e.g., 15000 for 30 seconds); your value must be greater or equal to 10000. The objective of this property is to help manage the number of calls that your activity makes to the Amazon Textract API.

オプション

分析の種類

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

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

DiscoverColumnHeaders

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

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

空の行を無視

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

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

S3 ストレージ

バケット

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

属性	詳細
入力	String
Required	はい
既定値	空
許容値	String または String 型変数を入力します。
備考	The AWS Region for the S3 bucket that contains the document must match the Region that you selected in the Amazon Scope activity. For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket; for more information, see step 6 in the Create IAM User section of the Setup guide.

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.

例

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

For step-by-step instructions and examples, see the Quickstart guides.