Document Models - List Analyze Batch Results

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-30

Zobrazení seznamu výsledků dávkové analýzy dokumentů

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Koncový bod služby Document Intelligence
modelId	path	True	string	Jedinečný název modelu dokumentu Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	PagedAnalyzeBatchOperation	Požadavek byl úspěšný.
Other Status Codes	DocumentIntelligenceErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

List Analyze Batch Documents Results

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AnalyzeBatchOperation	Stav a výsledek dávkové operace analýzy
AnalyzeBatchOperationDetail	Podrobnosti operace pro dokument v dávkové analýze
AnalyzeBatchResult	Výsledek dávkové analýzy dokumentů
DocumentIntelligenceError	Objekt chyby.
DocumentIntelligenceErrorResponse	Objekt odpovědi na chybu
DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace o chybě.
DocumentIntelligenceOperationStatus	Stav operace.
PagedAnalyzeBatchOperation	Stránkovaná kolekce položek AnalyzeBatchOperation

AnalyzeBatchOperation

Stav a výsledek dávkové operace analýzy

Name	Typ	Description
createdDateTime	string	Datum a čas (UTC) při odeslání operace
error	DocumentIntelligenceError	Při dávkové analýze dokumentu došlo k chybě.
lastUpdatedDateTime	string	Datum a čas (UTC) při poslední aktualizaci stavu
percentCompleted	integer	Průběh operace (0–100).
result	AnalyzeBatchResult	Výsledek dávkové analýzy dokumentů
resultId	string	Analyzujte ID výsledku dávkové operace.
status	DocumentIntelligenceOperationStatus	Stav operace. notStarted, running, succeeded, orfailed

AnalyzeBatchOperationDetail

Podrobnosti operace pro dokument v dávkové analýze

Name	Typ	Description
error	DocumentIntelligenceError	Došlo k chybě.
resultUrl	string	Adresa URL kódu JSON s analýzou výsledku
sourceUrl	string	Adresa URL zdrojového dokumentu
status	DocumentIntelligenceOperationStatus	Analyzujte stav. úspěšné, neúspěšné nebo přeskočené

AnalyzeBatchResult

Výsledek dávkové analýzy dokumentů

Name	Typ	Description
details	AnalyzeBatchOperationDetail[]	Podrobnosti o operaci pro každý dokument v dávce
failedCount	integer	Početdokumentůch
skippedCount	integer	Početdokumentůch
succeededCount	integer	Počet dokumentů, které se dokončily se stavem, bylo úspěšné.

DocumentIntelligenceError

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	DocumentIntelligenceError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

DocumentIntelligenceErrorResponse

Objekt odpovědi na chybu

Name	Typ	Description
error	DocumentIntelligenceError	Informace o chybě

DocumentIntelligenceInnerError

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	DocumentIntelligenceInnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.

DocumentIntelligenceOperationStatus

Stav operace.

Name	Typ	Description
canceled	string	Operace byla zrušena.
failed	string	Operace se nezdařila.
notStarted	string	Operace ještě nebyla spuštěna.
running	string	Operace probíhá.
skipped	string	Operace byla vynechána.
succeeded	string	Operace byla úspěšná.

PagedAnalyzeBatchOperation

Stránkovaná kolekce položek AnalyzeBatchOperation

Name	Typ	Description
nextLink	string	Odkaz na další stránku položek
value	AnalyzeBatchOperation[]	Položky AnalyzeBatchOperation na této stránce