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 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string uri	문서 인텔리전스 서비스 엔드포인트입니다.
modelId	path	True	string	고유한 문서 모델 이름입니다. regex 패턴: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
resultId	path	True	string uuid	일괄 처리 작업 결과 ID를 분석합니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	AnalyzeBatchOperation	요청이 성공했습니다.
Other Status Codes	DocumentIntelligenceErrorResponse	예기치 않은 오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

형식: apiKey
In(다음 안에): header

OAuth2Auth

형식: oauth2
Flow: accessCode
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL: https://login.microsoftonline.com/common/oauth2/token

범위

Name	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"
      }
    ]
  }
}

정의

Name	Description
AnalyzeBatchOperation	일괄 처리 분석 작업의 상태 및 결과입니다.
AnalyzeBatchOperationDetail	일괄 처리 분석의 문서에 대한 작업 세부 정보입니다.
AnalyzeBatchResult	일괄 처리 문서 분석 결과입니다.
DocumentIntelligenceError	오류 개체입니다.
DocumentIntelligenceErrorResponse	오류 응답 개체입니다.
DocumentIntelligenceInnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다.
DocumentIntelligenceOperationStatus	작업 상태입니다.

AnalyzeBatchOperation

일괄 처리 분석 작업의 상태 및 결과입니다.

Name	형식	Description
createdDateTime	string	작업이 제출된 날짜 및 시간(UTC)입니다.
error	DocumentIntelligenceError	일괄 처리 문서 분석 중에 오류가 발생했습니다.
lastUpdatedDateTime	string	상태가 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
percentCompleted	integer	작업 진행률(0-100).
result	AnalyzeBatchResult	일괄 처리 문서 분석 결과입니다.
resultId	string	일괄 처리 작업 결과 ID를 분석합니다.
status	DocumentIntelligenceOperationStatus	작업 상태입니다. notStarted, running, succeeded 또는 failed

AnalyzeBatchOperationDetail

일괄 처리 분석의 문서에 대한 작업 세부 정보입니다.

Name	형식	Description
error	DocumentIntelligenceError	오류가 발생했습니다.
resultUrl	string	분석 결과 JSON의 URL입니다.
sourceUrl	string	원본 문서의 URL입니다.
status	DocumentIntelligenceOperationStatus	상태를 분석합니다. 성공, 실패 또는 건너뛰기

AnalyzeBatchResult

일괄 처리 문서 분석 결과입니다.

Name	형식	Description
details	AnalyzeBatchOperationDetail[]	일괄 처리의 각 문서에 대한 작업 세부 정보입니다.
failedCount	integer	상태와 함께 완료되지 않은 문서 수입니다.
skippedCount	integer	상태를 건너뛰고 완료된 문서 수입니다.
succeededCount	integer	상태가 완료된 문서 수입니다.

DocumentIntelligenceError

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	DocumentIntelligenceError[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	DocumentIntelligenceInnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

DocumentIntelligenceErrorResponse

오류 응답 개체입니다.

Name	형식	Description
error	DocumentIntelligenceError	오류 정보입니다.

DocumentIntelligenceInnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror	DocumentIntelligenceInnerError	내부 오류입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

DocumentIntelligenceOperationStatus

작업 상태입니다.

Name	형식	Description
canceled	string	작업이 취소되었습니다.
failed	string	작업이 실패했습니다.
notStarted	string	작업이 아직 시작되지 않았습니다.
running	string	작업이 진행 중입니다.
skipped	string	작업이 건너뛰어졌습니다.
succeeded	string	작업이 성공했습니다.

다음을 통해 공유