document-understanding
latest
false
Document Understanding API 指南
请求响应架构
我们使用异步 API 检索的结果可能是正在处理、成功,也可能是失败。本页概述了调用
getResult
时,在这两种情况下通常返回的架构。学习解读这些结果是成功管理 API 和排除故障的关键。
仍在处理时,
getResult
调用将返回包含以下详细信息的架构:
status
:请求的当前状态。在本例中,状态为Running
。createdAt
:发起请求的日期和时间。lastUpdatedAt
:上次更新请求的日期和时间。
请求处理成功时,
getResult
调用将返回包含以下详细信息的架构:
status
:请求的当前状态。在本例中,状态为Succeeded
。createdAt
:发起请求的日期和时间。lastUpdatedAt
:上次更新请求的日期和时间。result
:请求的结果,例如提取结果(显示为extractionResult
)。
请求处理失败时,
getResult
调用将返回包含以下详细信息的架构:
status
:请求的当前状态。在本例中,状态为Failed
。createdAt
:发起请求的日期和时间。lastUpdatedAt
:上次更新请求的日期和时间。error
:错误原因,包含以下详细信息:message
:描述错误内容的详细解释,例如"Internal Server Error. Please contact the UiPath support team."
severity
:失败严重性。在本例中,严重性通常为Error
。code
:标识错误类型的特定代码,例如[UnexpectedInternalServerError]
。parameters
:包含其他与错误相关的信息(如果适用)。