你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Document Models - Get Analyze Batch Result

参考

服务:: Azure AI Services

API 版本:: 2024-11-30

获取批处理文档分析的结果。

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults/{resultId}?api-version=2024-11-30

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string uri	文档智能服务终结点。
modelId	path	True	string	唯一的文档模型名称。正则表达式模式: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
resultId	path	True	string uuid	分析批处理操作结果 ID。
api-version	query	True	string	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	AnalyzeBatchOperation	请求已成功。
Other Status Codes	DocumentIntelligenceErrorResponse	意外的错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Get Analyze Batch Documents Result

示例请求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

示例响应

状态代码:: 200

{
  "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "result": {
    "succeededCount": 1,
    "failedCount": 1,
    "skippedCount": 1,
    "details": [
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file1.pdf",
        "resultUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer/trainingDocsResult/file1.pdf.ocr.json",
        "status": "succeeded"
      },
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file2.jpg",
        "status": "failed",
        "error": {
          "code": "InvalidRequest",
          "message": "Invalid request.",
          "innererror": {
            "code": "InvalidContent",
            "message": "The file format is unsupported or corrupted. Refer to documentation for the list of supported formats."
          }
        }
      },
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file3.png",
        "status": "skipped"
      }
    ]
  }
}

定义

名称	说明
AnalyzeBatchOperation	分析批处理操作的状态和结果。
AnalyzeBatchOperationDetail	批处理分析中文档的操作详细信息。
AnalyzeBatchResult	批处理文档分析结果。
DocumentIntelligenceError	错误对象。
DocumentIntelligenceErrorResponse	错误响应对象。
DocumentIntelligenceInnerError	包含有关错误的更具体信息的对象。
DocumentIntelligenceOperationStatus	操作状态。

AnalyzeBatchOperation

分析批处理操作的状态和结果。

名称	类型	说明
createdDateTime	string	提交操作的日期和时间（UTC）。
error	DocumentIntelligenceError	批处理文档分析期间遇到错误。
lastUpdatedDateTime	string	上次更新状态的日期和时间（UTC）。
percentCompleted	integer	操作进度（0-100）。
result	AnalyzeBatchResult	批处理文档分析结果。
resultId	string	分析批处理操作结果 ID。
status	DocumentIntelligenceOperationStatus	操作状态。 notStarted、running、succeeded 或 failed

AnalyzeBatchOperationDetail

批处理分析中文档的操作详细信息。

名称	类型	说明
error	DocumentIntelligenceError	遇到错误。
resultUrl	string	分析结果 JSON 的 URL。
sourceUrl	string	源文档的 URL。
status	DocumentIntelligenceOperationStatus	分析状态。成功、失败或跳过

AnalyzeBatchResult

批处理文档分析结果。

名称	类型	说明
details	AnalyzeBatchOperationDetail[]	批处理中每个文档的操作详细信息。
failedCount	integer	状态失败完成的文档数。
skippedCount	integer	已跳过状态完成的文档数。
succeededCount	integer	状态成功完成的文档数。

DocumentIntelligenceError

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	DocumentIntelligenceError[]	导致此报告错误的特定错误的详细信息数组。
innererror	DocumentIntelligenceInnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

DocumentIntelligenceErrorResponse

错误响应对象。

名称	类型	说明
error	DocumentIntelligenceError	错误信息。

DocumentIntelligenceInnerError

包含有关错误的更具体信息的对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	DocumentIntelligenceInnerError	内部错误。
message	string	错误的人工可读表示形式。

DocumentIntelligenceOperationStatus

操作状态。

名称	类型	说明
canceled	string	操作已被取消。
failed	string	操作失败。
notStarted	string	操作尚未启动。
running	string	操作正在进行中。
skipped	string	操作已被跳过。
succeeded	string	操作已成功。

通过