GetExpenseAnalysis - Amazon Textract

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

GetExpenseAnalysis

获取分析发票和收据的 Amazon Textract 异步操作的结果。Amazon Textract 从输入的发票和收据中查找联系信息、购买的商品和供应商名称。

通过调用开始异步发票/收据分析StartExpenseAnalysis,它返回一个作业标识符 (JobId)。Amazon Textract 在完成发票/收据分析后,将完成状态发布到 Amazon Simple Notification Service (Amazon SNS) 主题。必须在初次调用时注册此主题StartExpenseAnalysis. 要获取发票/收据分析操作的结果,请先确保向 Amazon SNS 主题发布的状态值为SUCCEEDED. 如果是的话,打电话GetExpenseAnalysis,然后传递作业标识符(JobId) 从最初的电话到StartExpenseAnalysis.

使用 MaxResults 参数限制返回的块数量。如果结果超过中指定的结果MaxResults,的价值NextToken在操作响应中包含用于获取下一组结果的分页令牌。要获取下一页结果,请致电GetExpenseAnalysis,然后填充NextToken具有从上一次调用返回的令牌值的请求参数GetExpenseAnalysis.

有关更多信息,请参阅 。分析发票和收据.

请求语法

{ "JobId": "string", "MaxResults": number, "NextToken": "string" }

请求参数

请求接受采用 JSON 格式的以下数据。

JobId

文本检测作业的唯一标识符。这些区域有:JobId从返回StartExpenseAnalysis. 一个JobId值仅在 7 天内有效。

类型: 字符串

长度约束:最小长度为 1。最大长度为 64。

模式:^[a-zA-Z0-9-_]+$

必填项:是

MaxResults

每个分页呼叫返回的最大结果数量。您可以指定的最大值是 20。如果您指定的值大于 20,则最多返回 20 个结果。默认值为 20。

类型: 整数

有效范围:最小值为 1。

必填项:否

NextToken

如果之前的响应不完整(因为需要检索更多块),Amazon Textract 将在响应中返回分页令牌。您可以使用此分页令牌检索下一组块块。

类型: 字符串

长度约束:最小长度为 1。长度上限为 255。

模式:.*\S.*

必填项:否

响应语法

{ "AnalyzeExpenseModelVersion": "string", "DocumentMetadata": { "Pages": number }, "ExpenseDocuments": [ { "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ], "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

AnalyzeExpenseModelVersion

分析费用的当前模型版本。

类型: 字符串

DocumentMetadata

有关 Amazon Textract 处理的文档的信息。DocumentMetadata在 Amazon Textract 操作的分页回复的每一页中返回。

类型:DocumentMetadata 对象

ExpenseDocuments

Amazon Textract 检测到的费用。

类型: 数组ExpenseDocument对象

JobStatus

文本检测作业的当前状态。

类型: 字符串

有效值: IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS

NextToken

如果响应被截断,Amazon Textract 将返回此令牌。您可以在后续请求中使用此令牌检索下一组文本检测结果。

类型: 字符串

长度约束:最小长度为 1。长度上限为 255。

模式:.*\S.*

StatusMessage

如无法完成检测作业,则返回该项。包含发生什么错误的解释。

类型: 字符串

Warnings

文档的文本检测操作期间发生的警告列表。

类型: 数组Warning对象

错误

AccessDeniedException

您无权执行该操作。使用授权用户或 IAM 角色的 Amazon 资源名称 (ARN) 来执行操作。

HTTP 状态代码:400

InternalServerError

Amazon Textract 遇到了一个服务问题。重新尝试您的调用。

HTTP 状态代码:500

InvalidJobIdException

向传递了无效的作业标识符GetDocumentAnalysis或者去GetDocumentAnalysis.

HTTP 状态代码:400

InvalidKMSKeyException

表示输入的 KMS 密钥没有解密权限,或者 KMS 密钥输入错误。

HTTP 状态代码:400

InvalidParameterException

有一个输入参数违反了约束。例如,在同步操作中,InvalidParameterException如果两者都不会发生异常S3Object要么Bytes值在Document请求参数。先验证您的参数,然后重新调用 API 操作。

HTTP 状态代码:400

InvalidS3ObjectException

Amazon Textract 无法访问请求中指定的 S3 对象。有关更多信息,配置对 Amazon S3 的访问权限有关故障排除信息,请参阅。Amazon S3 故障排除

HTTP 状态代码:400

ProvisionedThroughputExceededException

请求数超出了您的吞吐量限制。如要增加此限制,请联系 Amazon Textract。

HTTP 状态代码:400

ThrottlingException

Amazon Textract 暂时无法处理该请求。重新尝试您的调用。

HTTP 状态代码:500

另请参阅

有关在特定语言的AWS软件开发工具包中使用此 API 的更多信息,请参阅以下内容: