Analyze Single Page Document

The Analyze Single Page Document activity uses the Amazon Textract AnalyzeDocument API to synchronously analyze a local document (DocumentPath) or a 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 PageDetail object (Page) that you can use as input variables in other activities outside of the Amazon Textract Activities Package.

動作のしくみ

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 Local Path or the S3 Storage input properties.
5. Create and enter a PageDetail variable for your Output (Page) property.
6. アクティビティを実行します。

   • Your input properties are sent to the AnalyzeDocument API.

   • The API returns the PageDetail value (Page) to your output property variable.

     

プロパティ

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

共通

表示名

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

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

ローカル パス

ドキュメントパス

分析するファイルのローカルの場所です。

属性	詳細
入力	String
Required	Yes (if S3 Storage properties are empty)
既定値	空
許容値	String または String 型変数を入力します。
備考	サポートされているドキュメント形式: PNG と JPEG (同期呼び出しでは PDF はサポートされていません)。

オプション

分析の種類

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

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

DiscoverColumnHeaders

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

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

空の行を無視

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

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

S3 ストレージ

バケット

ドキュメントが保存されている Amazon 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

出力

ページ

指定したドキュメントから抽出されたプロパティです。

属性	詳細
入力	PageDetail
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	PageDetail 型変数を入力します。
備考	See Page Detail for the description of the PageDetail object and its properties.

例

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

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