Get Document Analysis Status

[ ドキュメント分析のステータスを取得] アクティビティは、Amazon Textract の GetDocumentAnalysis API を使用して、既存または以前に実行されたドキュメント分析ジョブ ([ジョブ ID]) のステータスを非同期的に取得します。

After retrieving the document analysis, the activity returns the job status as a String value that you can use as a condition to run other activities (for example, Get Document Analysis).

To avoid overloading the Amazon Textract service with requests, it's recommended that you implement a delay between each execution of this activity (for example, add the Get Document Analysis Status and a Delay activity inside a Do While activity - see example section below)

動作のしくみ

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

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [Amazon スコープ ] アクティビティを追加します。
3. Add an activity or run an external process that outputs a JobId value (for example, Start Document Analysis).
4. [Amazon スコープ] アクティビティ内に [ドキュメント分析のステータスを取得] を追加します。
5. [入力] セクションのプロパティに値を入力します。
6. [出力] セクションのプロパティのために String 型変数を作成し、入力します。
7. アクティビティを実行します。

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

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

     

プロパティ

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

共通

表示名

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

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

入力

ジョブ ID

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

属性	詳細
入力	String
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	String または String 型変数を入力します。
備考	ジョブ ID Stringの値を取得するには、JobID値を出力に含める外部プロセスまたはアクティビティを使用します (例: [ドキュメントの分析を開始] または外部 API 呼び出し)

その他

プライベート (Private)

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

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

出力

JobStatus

指定した ジョブ ID のステータスです。

属性	詳細
入力	String
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	String 型変数を入力します。
備考	以下の 4 つのステータス値が考られます。 IN_PROGRESS 成功 失敗 PARTIAL_SUCCESS

例

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

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