Document Models - Get Analyze Batch Result
Obtém o resultado da análise de documento em lote.
GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults/{resultId}?api-version=2024-11-30
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
O ponto de extremidade do serviço do Document Intelligence. |
model
|
path | True |
string |
Nome exclusivo do modelo de documento. Padrão Regex: |
result
|
path | True |
string uuid |
Analise a ID do resultado da operação em lote. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A solicitação foi bem-sucedida. |
|
Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
URL do Token:
https://login.microsoftonline.com/common/oauth2/token
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemplos
Get Analyze Batch Documents Result
Solicitação de exemplo
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30
Resposta de exemplo
{
"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"
}
]
}
}
Definições
Nome | Description |
---|---|
Analyze |
Status e resultado da operação de análise de lote. |
Analyze |
Detalhes da operação de um documento em uma análise em lote. |
Analyze |
Resultado da análise do documento em lote. |
Document |
O objeto de erro. |
Document |
Objeto de resposta de erro. |
Document |
Um objeto que contém informações mais específicas sobre o erro. |
Document |
Status da operação. |
AnalyzeBatchOperation
Status e resultado da operação de análise de lote.
Nome | Tipo | Description |
---|---|---|
createdDateTime |
string |
Data e hora (UTC) quando a operação foi enviada. |
error |
Erro encontrado durante a análise do documento em lote. |
|
lastUpdatedDateTime |
string |
Data e hora (UTC) quando o status foi atualizado pela última vez. |
percentCompleted |
integer |
Progresso da operação (0-100). |
result |
Resultado da análise do documento em lote. |
|
resultId |
string |
Analise a ID do resultado da operação em lote. |
status |
Status da operação. notStarted, running, succeeded ou failed |
AnalyzeBatchOperationDetail
Detalhes da operação de um documento em uma análise em lote.
Nome | Tipo | Description |
---|---|---|
error |
Erro encontrado. |
|
resultUrl |
string |
URL do JSON do resultado da análise. |
sourceUrl |
string |
URL do documento de origem. |
status |
Analisar o status. bem-sucedido, com falha ou ignorado |
AnalyzeBatchResult
Resultado da análise do documento em lote.
Nome | Tipo | Description |
---|---|---|
details |
Detalhes da operação para cada documento no lote. |
|
failedCount |
integer |
Falha no número de documentos concluídos com status. |
skippedCount |
integer |
Número de documentos que foram concluídos com o status ignorado. |
succeededCount |
integer |
Número de documentos que foram concluídos com status bem-sucedido. |
DocumentIntelligenceError
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Uma representação legível pelo ser humano do erro. |
target |
string |
O destino do erro. |
DocumentIntelligenceErrorResponse
Objeto de resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
Informações de erro. |
DocumentIntelligenceInnerError
Um objeto que contém informações mais específicas sobre o erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
innererror |
Erro interno. |
|
message |
string |
Uma representação legível pelo ser humano do erro. |
DocumentIntelligenceOperationStatus
Status da operação.
Nome | Tipo | Description |
---|---|---|
canceled |
string |
A operação foi cancelada. |
failed |
string |
A operação falhou. |
notStarted |
string |
A operação ainda não foi iniciada. |
running |
string |
A operação está em andamento. |
skipped |
string |
A operação foi ignorada. |
succeeded |
string |
A operação foi bem-sucedida. |