获取文档分析状态

The Get Document Analysis Status activity uses the Amazon Textract GetDocumentAnalysis API to asynchronously retrieve the status of an existing or previously executed document analysis job (JobId).

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)

工作方式

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 an activity or run an external process that outputs a JobId value (for example, Start Document Analysis).
4. Add the Get Document Analysis Status inside the Amazon Scope activity.
5. （可选）为输入属性输入值。
6. Create and enter a String variable for your Output property.
7. 运行活动。

   • Your input properties are sent to the GetDocumentAnalysis API.

   • API 会将 String 值返回到您的输出属性变量。

     

属性

将此活动添加到 UiPath Studio 中的项目时，会指定以下属性的值。

常见

显示名称

活动的显示名称。

属性	详细信息
类型	String
必填	是
默认值	Get Document Analysis Status
允许的值	输入 String 或 String 变量。
注意	不适用

输入

作业 ID

分配给要检索的文档分析流程的标识符。

属性	详细信息
类型	String
必填	否（如果您计划在后续活动中使用输出数据，则建议使用此选项）
默认值	空白
允许的值	输入 String 或 String 变量
注意	To get the JobId String value, use an external process or activity that includes the JobID value in its output (e.g., Start Document Analysis or external API call)

其他

私有

如果已选择，变量和参数的值将不会在 Verbose 级进行记录。

属性	详细信息
类型	复选框
必填	否
默认值	未选中
允许的值	已选择或未选择
注意	不适用

输出

JobStatus

The status of the specified JobId.

属性	详细信息
类型	String
必填	否（如果您计划在后续活动中使用输出数据，则建议使用此选项）
默认值	空白
允许的值	输入 String 变量
注意	有 4 个可能的状态值： IN_PROGRESS 成功 失败 PARTIAL_SUCCESS

示例

下图显示了活动依赖关系和输入/输出属性值的示例。

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