Start Document Analysis

[ドキュメントの分析を開始] アクティビティは、Amazon Textract の StartDocumentAnalysis API を使用して、Amazon S3 バケット ([バケット]) に保存されているドキュメント ([ドキュメントの名前] と [バージョン]) の分析を非同期的に開始します。

ドキュメント分析の開始後、アクティビティはドキュメント分析プロセスに割り当てられた識別子を String (ジョブ ID) として返します。この識別子は、[ ドキュメント分析のステータスを取得] アクティビティおよび [ドキュメント分析を取得 ] アクティビティで入力変数として使用できます。

動作のしくみ

以下の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

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

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

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

     

プロパティ

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

共通

表示名

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

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

S3 ストレージ

バケット

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

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

DocumentName

分析を開始する、指定された バケット 内の、大文字と小文字を区別するファイルの名前です。

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

バージョン

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

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

その他

プライベート (Private)

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

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

出力

ジョブ ID

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

属性	詳細
入力	String
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	String 型変数を入力します。
備考	このプロパティ用に作成した変数は、[ ドキュメント分析のステータスを取得 ] アクティビティおよびアクティビティの入力変数として使用できます。JobId 値は 7 日間のみ有効です。

オプション

分析の種類

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

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

例

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

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