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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	Document Intelligence 服務端點。
modelId	path	True	string	唯一的檔模型名稱。 Regex 模式: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
resultId	path	True	string uuid	分析批次作業結果標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	AnalyzeBatchOperation	要求已成功。
Other Status Codes	DocumentIntelligenceErrorResponse	未預期的錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
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"
      }
    ]
  }
}

定義

名稱	Description
AnalyzeBatchOperation	分析批次作業的狀態和結果。
AnalyzeBatchOperationDetail	批次分析中文件的作業詳細數據。
AnalyzeBatchResult	批次檔分析結果。
DocumentIntelligenceError	error 物件。
DocumentIntelligenceErrorResponse	錯誤回應物件。
DocumentIntelligenceInnerError	物件，包含有關錯誤的更特定資訊。
DocumentIntelligenceOperationStatus	作業狀態。

AnalyzeBatchOperation

分析批次作業的狀態和結果。

名稱	類型	Description
createdDateTime	string	提交作業的日期和時間（UTC）。
error	DocumentIntelligenceError	批次檔分析期間發生錯誤。
lastUpdatedDateTime	string	上次更新狀態的日期和時間（UTC）。
percentCompleted	integer	作業進度（0-100）。
result	AnalyzeBatchResult	批次檔分析結果。
resultId	string	分析批次作業結果標識碼。
status	DocumentIntelligenceOperationStatus	作業狀態。 notStarted、執行中、成功或失敗

AnalyzeBatchOperationDetail

批次分析中文件的作業詳細數據。

名稱	類型	Description
error	DocumentIntelligenceError	發生錯誤。
resultUrl	string	分析結果 JSON 的 URL。
sourceUrl	string	源檔的 URL。
status	DocumentIntelligenceOperationStatus	分析狀態。成功、失敗或略過

AnalyzeBatchResult

批次檔分析結果。

名稱	類型	Description
details	AnalyzeBatchOperationDetail[]	批次中每個文件的作業詳細數據。
failedCount	integer	完成且狀態失敗的檔數目。
skippedCount	integer	已完成且略過狀態的檔數目。
succeededCount	integer	狀態成功完成的檔數目。

DocumentIntelligenceError

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	DocumentIntelligenceError[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	DocumentIntelligenceInnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

DocumentIntelligenceErrorResponse

錯誤回應物件。

名稱	類型	Description
error	DocumentIntelligenceError	錯誤資訊。

DocumentIntelligenceInnerError

物件，包含有關錯誤的更特定資訊。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	DocumentIntelligenceInnerError	內部錯誤。
message	string	錯誤的人類可讀取表示法。

DocumentIntelligenceOperationStatus

作業狀態。

名稱	類型	Description
canceled	string	作業已取消。
failed	string	作業失敗。
notStarted	string	作業尚未啟動。
running	string	作業正在進行中。
skipped	string	作業已略過。
succeeded	string	作業已成功。

共用方式為