Condividi tramite

Document Models - List Analyze Batch Results

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2024-11-30

Elencare i risultati dell'analisi dei documenti batch.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

uri

Endpoint del servizio Document Intelligence.
modelId
 path True

string

Nome univoco del modello di documento.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

PagedAnalyzeBatchOperation

La richiesta ha avuto esito positivo.
Other Status Codes

DocumentIntelligenceErrorResponse

Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome Descrizione
https://cognitiveservices.azure.com/.default

Esempio

List Analyze Batch Documents Results

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}

Definizioni

Nome Descrizione
AnalyzeBatchOperation

Stato e risultato dell'operazione di analisi batch.
AnalyzeBatchOperationDetail

Dettagli dell'operazione per un documento in un'analisi batch.
AnalyzeBatchResult

Risultato dell'analisi dei documenti batch.
DocumentIntelligenceError

Oggetto error.
DocumentIntelligenceErrorResponse

Oggetto risposta di errore.
DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche sull'errore.
DocumentIntelligenceOperationStatus

Stato dell'operazione.
PagedAnalyzeBatchOperation

Raccolta di pagine di elementi AnalyzeBatchOperation

AnalyzeBatchOperation

Stato e risultato dell'operazione di analisi batch.

Nome Tipo Descrizione
createdDateTime

string

Data e ora (UTC) in cui è stata inviata l'operazione.
error

DocumentIntelligenceError

Errore durante l'analisi dei documenti batch.
lastUpdatedDateTime

string

Data e ora (UTC) dell'ultimo aggiornamento dello stato.
percentCompleted

integer

Stato dell'operazione (0-100).
result

AnalyzeBatchResult

Risultato dell'analisi dei documenti batch.
resultId

string

Analizzare l'ID risultato dell'operazione batch.
status

DocumentIntelligenceOperationStatus

Stato dell'operazione. notStarted, running, succeeded o failed

AnalyzeBatchOperationDetail

Dettagli dell'operazione per un documento in un'analisi batch.

Nome Tipo Descrizione
error

DocumentIntelligenceError

Errore rilevato.
resultUrl

string

URL del codice JSON del risultato di analisi.
sourceUrl

string

URL del documento di origine.
status

DocumentIntelligenceOperationStatus

Analizzare lo stato. riuscito, non riuscito o ignorato

AnalyzeBatchResult

Risultato dell'analisi dei documenti batch.

Nome Tipo Descrizione
details

AnalyzeBatchOperationDetail[]

Dettagli dell'operazione per ogni documento nel batch.
failedCount

integer

Numero di documenti completati con stato non riuscito.
skippedCount

integer

Numero di documenti completati con stato ignorato.
succeededCount

integer

Numero di documenti completati con stato completato.

DocumentIntelligenceError

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

DocumentIntelligenceError[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

DocumentIntelligenceErrorResponse

Oggetto risposta di errore.

Nome Tipo Descrizione
error

DocumentIntelligenceError

Informazioni sull'errore.

DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche sull'errore.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
innererror

DocumentIntelligenceInnerError

Errore interno.
message

string

Rappresentazione leggibile dell'errore.

DocumentIntelligenceOperationStatus

Stato dell'operazione.

Nome Tipo Descrizione
canceled

string

L'operazione è stata annullata.
failed

string

L'operazione non è riuscita.
notStarted

string

L'operazione non è ancora stata avviata.
running

string

L'operazione è in corso.
skipped

string

L'operazione è stata ignorata.
succeeded

string

Operazione completata.

PagedAnalyzeBatchOperation

Raccolta di pagine di elementi AnalyzeBatchOperation

Nome Tipo Descrizione
nextLink

string

Collegamento alla pagina successiva di elementi
value

AnalyzeBatchOperation[]

Elementi AnalyzeBatchOperation in questa pagina