Document Models - Get Analyze Batch Result

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-07-31-preview

Ruft das Ergebnis der Batchdokumentanalyse ab.

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults/{resultId}?api-version=2024-07-31-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Document Intelligence-Dienstendpunkt.
modelId	path	True	string	Eindeutiger Dokumentmodellname. RegEx-Muster: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
resultId	path	True	string uuid	Analysieren Sie die Ergebnis-ID des Batchvorgangs.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AnalyzeBatchResultOperation	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Get Analyze Batch Documents Result

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "status": "completed",
  "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"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AnalyzeBatchOperationDetail	Vorgangsdetails für ein Dokument in einer Batchanalyse.
AnalyzeBatchResult	Batchdokumentanalyseergebnis.
AnalyzeBatchResultOperation	Status und Ergebnis des Analysebatchvorgangs.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
OperationStatus	Vorgangsstatus.

AnalyzeBatchOperationDetail

Vorgangsdetails für ein Dokument in einer Batchanalyse.

Name	Typ	Beschreibung
error	Error	Fehler.
resultUrl	string	DIE URL des Analyseergebnis-JSON.
sourceUrl	string	URL des Quelldokuments.
status	OperationStatus	Analysieren sie den Status. erfolgreich, fehlgeschlagen oder übersprungen

AnalyzeBatchResult

Batchdokumentanalyseergebnis.

Name	Typ	Beschreibung
details	AnalyzeBatchOperationDetail[]	Vorgangsdetails für jedes Dokument im Batch.
failedCount	integer	Die Anzahl der Dokumente, die mit dem Status abgeschlossen wurden, ist fehlgeschlagen.
skippedCount	integer	Die Anzahl der Dokumente, die mit übersprungenen Status abgeschlossen wurden.
succeededCount	integer	Die Anzahl der Dokumente, die mit dem Status abgeschlossen wurden.

AnalyzeBatchResultOperation

Status und Ergebnis des Analysebatchvorgangs.

Name	Typ	Beschreibung
createdDateTime	string	Datum und Uhrzeit (UTC), wann der Vorgang übermittelt wurde.
error	Error	Fehler während der Batchdokumentanalyse.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wurde.
percentCompleted	integer	Vorgangsfortschritt (0-100).
result	AnalyzeBatchResult	Batchdokumentanalyseergebnis.
status	OperationStatus	Vorgangsstatus. notStarted, running, completed, or failed

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

OperationStatus

Vorgangsstatus.

Name	Typ	Beschreibung
canceled	string	Der Vorgang wurde abgebrochen.
completed	string	Der Vorgang wurde abgeschlossen.
failed	string	Fehler beim Vorgang.
notStarted	string	Der Vorgang wurde noch nicht gestartet.
running	string	Der Vorgang wird ausgeführt.
succeeded	string	Der Vorgang ist erfolgreich.

Freigeben über