Document Models - List Analyze Batch Results

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Wyświetlanie listy wyników analizy dokumentów wsadowych.

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults?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 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unikatowa nazwa modelu dokumentu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PagedAnalyzeBatchOperation	Żą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

List Analyze Batch Documents Results

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

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.
PagedAnalyzeBatchOperation	Stronicowana kolekcja elementów AnalyzeBatchOperation

AnalyzeBatchOperation

Objekt

Stan i wynik operacji analizy wsadowej.

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

AnalyzeBatchOperationDetail

Objekt

Szczegóły operacji dla dokumentu w analizie wsadowej.

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

AnalyzeBatchResult

Objekt

Wynik analizy dokumentu wsadowego.

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

DocumentIntelligenceError

Objekt

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

Objekt

Błąd obiektu odpowiedzi.

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

DocumentIntelligenceInnerError

Objekt

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

Wyliczanie

Stan operacji.

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

PagedAnalyzeBatchOperation

Objekt

Stronicowana kolekcja elementów AnalyzeBatchOperation

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	AnalyzeBatchOperation[]	Elementy AnalyzeBatchOperation na tej stronie