Document Models - Get Analyze Batch Result

Tjänst:

Azure AI Services

API-version:

2024-11-30

Hämtar resultatet av batchdokumentanalys.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkten för document intelligence-tjänsten.
modelId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unikt dokumentmodellnamn.
resultId	path	True	string (uuid)	Analysera resultat-ID för batchåtgärd.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	AnalyzeBatchOperation	Begäran har slutförts.
Other Status Codes	DocumentIntelligenceErrorResponse	Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

Name	Description
https://cognitiveservices.azure.com/.default

Exempel

Get Analyze Batch Documents Result

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AnalyzeBatchOperation	Status och resultat av batchanalysåtgärden.
AnalyzeBatchOperationDetail	Åtgärdsinformation för ett dokument i en batchanalys.
AnalyzeBatchResult	Resultat av batchdokumentanalys.
DocumentIntelligenceError	Felobjektet.
DocumentIntelligenceErrorResponse	Felsvarsobjekt.
DocumentIntelligenceInnerError	Ett objekt som innehåller mer specifik information om felet.
DocumentIntelligenceOperationStatus	Åtgärdsstatus.

AnalyzeBatchOperation

Objekt

Status och resultat av batchanalysåtgärden.

Name	Typ	Description
createdDateTime	string (date-time)	Datum och tid (UTC) när åtgärden skickades.
error	DocumentIntelligenceError	Ett fel uppstod under batchdokumentanalysen.
lastUpdatedDateTime	string (date-time)	Datum och tid (UTC) när statusen senast uppdaterades.
percentCompleted	integer (int32) minimum: 0 maximum: 100	Åtgärdsförlopp (0–100).
result	AnalyzeBatchResult	Resultat av batchdokumentanalys.
resultId	string (uuid)	Analysera resultat-ID för batchåtgärd.
status	DocumentIntelligenceOperationStatus	Åtgärdsstatus. notStarted, running, succeeded eller failed

AnalyzeBatchOperationDetail

Objekt

Åtgärdsinformation för ett dokument i en batchanalys.

Name	Typ	Description
error	DocumentIntelligenceError	Fel påträffades.
resultUrl	string (uri)	URL för analysresultatets JSON.
sourceUrl	string (uri)	URL för källdokumentet.
status	DocumentIntelligenceOperationStatus	Analysera status. lyckades, misslyckades eller hoppades över

AnalyzeBatchResult

Objekt

Resultat av batchdokumentanalys.

Name	Typ	Description
details	AnalyzeBatchOperationDetail[]	Åtgärdsinformation för varje dokument i batchen.
failedCount	integer (int32)	Antalet dokument som slutfördes med statusen misslyckades.
skippedCount	integer (int32)	Antal dokument som har slutförts med status överhoppad.
succeededCount	integer (int32)	Antal dokument som har slutförts med statusen lyckades.

DocumentIntelligenceError

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	DocumentIntelligenceError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	DocumentIntelligenceInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

DocumentIntelligenceErrorResponse

Objekt

Felsvarsobjekt.

Name	Typ	Description
error	DocumentIntelligenceError	Felinformation.

DocumentIntelligenceInnerError

Objekt

Ett objekt som innehåller mer specifik information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	DocumentIntelligenceInnerError	Inre fel.
message	string	En mänsklig läsbar representation av felet.

DocumentIntelligenceOperationStatus

Uppräkning

Åtgärdsstatus.

Värde	Description
canceled	Åtgärden har avbrutits.
failed	Åtgärden misslyckades.
notStarted	Åtgärden har inte startats än.
running	Åtgärden pågår.
skipped	Åtgärden har hoppats över.
succeeded	Åtgärden har slutförts.