Document Models - List Analyze Batch Results

Dienst:

Azure AI Services

API-Version:

2024-11-30

Ergebnisse der Batchdokumentanalyse auflisten.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Document Intelligence-Dienstendpunkt.
modelId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Eindeutiger Dokumentmodellname.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PagedAnalyzeBatchOperation	Die Anforderung ist erfolgreich.
Other Status Codes	DocumentIntelligenceErrorResponse	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

List Analyze Batch Documents Results

Beispielanforderung

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults?api-version=2024-11-30

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "resultId": "f4d8b3b3-7f76-4b3b-8b3b-3b7f76f4d8b3",
      "status": "succeeded",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "lastUpdatedDateTime": "2021-09-24T12:54:35Z"
    },
    {
      "resultId": "f4d8b3b3-7f76-4b3b-8b3b-3b7f76f4d8b4",
      "status": "running",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "lastUpdatedDateTime": "2021-09-24T12:54:35Z"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults?nextLink=nextLinkData"
}

Definitionen

Name	Beschreibung
AnalyzeBatchOperation	Status und Ergebnis des Analysebatchvorgangs.
AnalyzeBatchOperationDetail	Vorgangsdetails für ein Dokument in einer Batchanalyse.
AnalyzeBatchResult	Batchdokumentanalyseergebnis.
DocumentIntelligenceError	Das Fehlerobjekt.
DocumentIntelligenceErrorResponse	Fehlerantwortobjekt.
DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
DocumentIntelligenceOperationStatus	Vorgangsstatus.
PagedAnalyzeBatchOperation	Paged-Auflistung von AnalyzeBatchOperation-Elementen

AnalyzeBatchOperation

Objekt

Status und Ergebnis des Analysebatchvorgangs.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Datum und Uhrzeit (UTC), wann der Vorgang übermittelt wurde.
error	DocumentIntelligenceError	Fehler während der Batchdokumentanalyse.
lastUpdatedDateTime	string (date-time)	Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wurde.
percentCompleted	integer (int32) minimum: 0 maximum: 100	Vorgangsfortschritt (0-100).
result	AnalyzeBatchResult	Batchdokumentanalyseergebnis.
resultId	string (uuid)	Analysieren Sie die Ergebnis-ID des Batchvorgangs.
status	DocumentIntelligenceOperationStatus	Vorgangsstatus. notStarted, running, succeeded oder failed

AnalyzeBatchOperationDetail

Objekt

Vorgangsdetails für ein Dokument in einer Batchanalyse.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehler.
resultUrl	string (uri)	DIE URL des Analyseergebnis-JSON.
sourceUrl	string (uri)	URL des Quelldokuments.
status	DocumentIntelligenceOperationStatus	Analysieren sie den Status. erfolgreich, fehlgeschlagen oder übersprungen

AnalyzeBatchResult

Objekt

Batchdokumentanalyseergebnis.

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

DocumentIntelligenceError

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	DocumentIntelligenceError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objekt

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehlerinformationen.

DocumentIntelligenceInnerError

Objekt

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

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

DocumentIntelligenceOperationStatus

Enumeration

Vorgangsstatus.

Wert	Beschreibung
notStarted	Der Vorgang wurde noch nicht gestartet.
running	Der Vorgang wird ausgeführt.
failed	Fehler beim Vorgang.
succeeded	Der Vorgang ist erfolgreich.
canceled	Der Vorgang wurde abgebrochen.
skipped	Der Vorgang wurde übersprungen.

PagedAnalyzeBatchOperation

Objekt

Paged-Auflistung von AnalyzeBatchOperation-Elementen

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	AnalyzeBatchOperation[]	Die AnalyseBatchOperation-Elemente auf dieser Seite