Start Document Analysis

The Start Document Analysis activity uses the Amazon Textract StartDocumentAnalysis API to asynchronously start the analysis of a document (DocumentName and Version) stored in an Amazon S3 bucket (Bucket).

After starting the document analysis, the activity returns the identifier assigned to the document analysis process as a String (JobId) that you can use as an input variable in the Get Document Analysis Status and Get Document Analysis activities.

動作のしくみ

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

1. 「セットアップ」の手順を完了します。
2. Add the Amazon Scope activity to your project.
3. Add the Start Document Analysis inside the Amazon Scope activity.
4. Enter values for the S3 Storage input properties.
5. [出力] セクションのプロパティのために String 型変数を作成し、入力します。
6. アクティビティを実行します。

   • Your input properties are sent to the StartDocumentAnalysis API.

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

     

プロパティ

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

共通

表示名

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

属性	詳細
入力	String
Required	はい
既定値	Start Document Analysis
許容値	String または String 型変数を入力します。
備考	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 start analyzing.

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

バージョン

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

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

その他

プライベート (Private)

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

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

出力

ジョブ ID

ドキュメント分析プロセスに割り当てられた識別子です。

属性	詳細
入力	String
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	String 型変数を入力します。
備考	The variable you create for this property can be used as an input variable in the Get Document Analysis Status and activities. A JobId value is only valid for 7 days.

オプション

分析の種類

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

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

例

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

ステップバイステップの手順と例については、ガイドをご覧ください。