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 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	一意のドキュメント モデル名。
resultId	path	True	string (uuid)	バッチ操作の結果 ID を分析します。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AnalyzeBatchOperation	要求は成功しました。
Other Status Codes	DocumentIntelligenceErrorResponse	予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン 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

Object

バッチ分析操作の状態と結果。

名前	型	説明
createdDateTime	string (date-time)	操作が送信された日時 (UTC)。
error	DocumentIntelligenceError	バッチ ドキュメント分析中にエラーが発生しました。
lastUpdatedDateTime	string (date-time)	状態が最後に更新された日時 (UTC)。
percentCompleted	integer (int32) minimum: 0 maximum: 100	操作の進行状況 (0 から 100)。
result	AnalyzeBatchResult	バッチ ドキュメント分析結果。
resultId	string (uuid)	バッチ操作の結果 ID を分析します。
status	DocumentIntelligenceOperationStatus	操作の状態。 notStarted、running、succeeded、または failed

AnalyzeBatchOperationDetail

Object

バッチ分析でのドキュメントの操作の詳細。

名前	型	説明
error	DocumentIntelligenceError	エラーが発生しました。
resultUrl	string (uri)	分析結果 JSON の URL。
sourceUrl	string (uri)	ソース ドキュメントの URL。
status	DocumentIntelligenceOperationStatus	状態を分析します。 succeeded、failed、または skipped

AnalyzeBatchResult

Object

バッチ ドキュメント分析結果。

名前	型	説明
details	AnalyzeBatchOperationDetail[]	バッチ内の各ドキュメントの操作の詳細。
failedCount	integer (int32)	状態で完了したドキュメントの数が失敗しました。
skippedCount	integer (int32)	状態がスキップされた状態で完了したドキュメントの数。
succeededCount	integer (int32)	状態が成功した状態で完了したドキュメントの数。

DocumentIntelligenceError

Object

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
details	DocumentIntelligenceError[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	DocumentIntelligenceInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

DocumentIntelligenceErrorResponse

Object

エラー応答オブジェクト。

名前	型	説明
error	DocumentIntelligenceError	エラー情報。

DocumentIntelligenceInnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
innererror	DocumentIntelligenceInnerError	内部エラー。
message	string	エラーの人間が判読できる表現。

DocumentIntelligenceOperationStatus

列挙

操作の状態。

値	説明
canceled	操作が取り消されました。
failed	操作が失敗しました。
notStarted	操作はまだ開始されていません。
running	操作が進行中です。
skipped	操作はスキップされました。
succeeded	操作は成功しました。