Start Document Analysis

用于使用 Amazon Textract API 异步启动对 Amazon S3 存储桶中存储的文档的分析

“启动文档分析”活动使用 Amazon Textract StartDocumentAnalysis API 异步启动对存储在 Amazon S3 存储桶 ( Bucket ) 中的文档（ “文档名称”和“版本” ）的分析。

启动文档分析后，该活动将返回分配给文档分析流程的标识符作为String ( JobId )，您可以在“获取文档分析状态”和“获取文档分析”活动中将其用作输入变量。

工作方式

以下步骤和消息序列图是活动从设计时（即活动依赖项和输入/输出属性）到运行时如何工作的示例。

1. 完成设置步骤。
2. 将“Amazon 作用域”活动添加到您的项目中。
3. 在“Amazon 作用域”活动中添加“启动文档分析” 。
4. 为“S3 存储”输入属性输入值。
5. 为“输出”属性创建并输入String变量。
6. 运行活动。

   • 您的输入属性将发送到“启动文档分析”API。

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

     

属性

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

常见

显示名称

活动的显示名称。

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

S3 存储

存储桶

存储文档的 S3 存储桶的名称。

属性	详细信息
类型	String
必填	是
默认值	空白
允许的值	输入 String 或 String 变量。
注意	包含文档的 S3 存储桶的 AWS 区域必须与您在“Amazon 作用域”活动中选择的区域匹配。为了让 Amazon Textract 处理 S3 存储桶中的文件，用户必须有权访问 S3 存储桶；有关更多信息，请参阅设置指南中“创建 IAM 用户”部分中的步骤 6 。

文档名称

要开始分析的指定存储桶中文件的名称（区分大小写）。

属性	详细信息
类型	String
必填	是
默认值	空白
允许的值	输入 String 或 String 变量。
注意	支持的文档格式：PNG、JPEG 和 PDF。

版本

如果存储桶启用了版本控制，则您可以指定对象版本。

属性	详细信息
类型	String
必填	否
默认值	空白
允许的值	输入 String 或 String 变量。
注意	不适用

其他

私有

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

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

输出

作业 ID

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

属性	详细信息
类型	String
必填	否（如果您计划在后续活动中使用输出数据，则建议使用此选项）
默认值	空白
允许的值	输入 String 变量
注意	您为此属性创建的变量可用作“获取 Document Understanding 状态”和“活动”中的输入变量。JobId值的有效期仅 7 天。

选项

分析类型

指定要执行的分析类型。 使用表格返回在输入文档中检测到的表格的相关信息，并使用表单返回检测到的表单数据。

属性	详细信息
类型	枚举
必填	编号
默认值	全部
允许的值	全部、表格、表单
注意	不适用

示例

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

有关分步说明和示例，请参阅指南。