Document Models - Get Analyze Batch Result

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-11-30

Pobiera wynik analizy dokumentów wsadowych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Punkt końcowy usługi Analizy dokumentów.
modelId	path	True	string	Unikatowa nazwa modelu dokumentu. Wzorzec wyrażenia regularnego: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
resultId	path	True	string uuid	Analizowanie identyfikatora wyniku operacji wsadowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnalyzeBatchOperation	Żądanie zakończyło się pomyślnie.
Other Status Codes	DocumentIntelligenceErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get Analyze Batch Documents Result

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    ]
  }
}

Definicje

Nazwa	Opis
AnalyzeBatchOperation	Stan i wynik operacji analizy wsadowej.
AnalyzeBatchOperationDetail	Szczegóły operacji dla dokumentu w analizie wsadowej.
AnalyzeBatchResult	Wynik analizy dokumentu wsadowego.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
DocumentIntelligenceOperationStatus	Stan operacji.

AnalyzeBatchOperation

Stan i wynik operacji analizy wsadowej.

Nazwa	Typ	Opis
createdDateTime	string	Data i godzina (UTC), kiedy operacja została przesłana.
error	DocumentIntelligenceError	Napotkano błąd podczas analizy dokumentu wsadowego.
lastUpdatedDateTime	string	Data i godzina (UTC), kiedy stan został ostatnio zaktualizowany.
percentCompleted	integer	Postęp operacji (0–100).
result	AnalyzeBatchResult	Wynik analizy dokumentu wsadowego.
resultId	string	Analizowanie identyfikatora wyniku operacji wsadowej.
status	DocumentIntelligenceOperationStatus	Stan operacji. notStarted, running, succeeded, or failed

AnalyzeBatchOperationDetail

Szczegóły operacji dla dokumentu w analizie wsadowej.

Nazwa	Typ	Opis
error	DocumentIntelligenceError	Napotkano błąd.
resultUrl	string	Adres URL wyniku analizy JSON.
sourceUrl	string	Adres URL dokumentu źródłowego.
status	DocumentIntelligenceOperationStatus	Analizowanie stanu. powodzenie, niepowodzenie lub pominięte

AnalyzeBatchResult

Wynik analizy dokumentu wsadowego.

Nazwa	Typ	Opis
details	AnalyzeBatchOperationDetail[]	Szczegóły operacji dla każdego dokumentu w partii.
failedCount	integer	Liczba dokumentów zakończonych stanem nie powiodła się.
skippedCount	integer	Liczba dokumentów zakończonych z pominiętym stanem.
succeededCount	integer	Liczba dokumentów zakończonych pomyślnie.

DocumentIntelligenceError

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	DocumentIntelligenceError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

DocumentIntelligenceErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	DocumentIntelligenceError	Informacje o błędzie.

DocumentIntelligenceInnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	DocumentIntelligenceInnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

DocumentIntelligenceOperationStatus

Stan operacji.

Nazwa	Typ	Opis
canceled	string	Operacja została anulowana.
failed	string	Operacja nie powiodła się.
notStarted	string	Operacja nie została jeszcze uruchomiona.
running	string	Operacja jest w toku.
skipped	string	Operacja została pominięta.
succeeded	string	Operacja zakończyła się pomyślnie.

Udostępnij za pośrednictwem