Document Models - List Analyze Batch Results

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Listar os resultados da análise de documentos em lote.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço de Inteligência de Documentos.
modelId	path	True	string	Nome exclusivo do modelo de documento. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	PagedAnalyzeBatchOperation	O pedido foi bem-sucedido.
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

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

Exemplos

List Analyze Batch Documents Results

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
AnalyzeBatchOperation	Status e resultado da operação de processamento em lote.
AnalyzeBatchOperationDetail	Detalhes da operação de um documento em uma análise de lote.
AnalyzeBatchResult	Resultado da análise de documentos em lote.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
DocumentIntelligenceOperationStatus	Estado da operação.
PagedAnalyzeBatchOperation	Coleção paginada de itens AnalyzeBatchOperation

AnalyzeBatchOperation

Status e resultado da operação de processamento em lote.

Name	Tipo	Description
createdDateTime	string	Data e hora (UTC) em que a operação foi submetida.
error	DocumentIntelligenceError	Erro encontrado durante a análise de documentos em lote.
lastUpdatedDateTime	string	Data e hora (UTC) em que o estado foi atualizado pela última vez.
percentCompleted	integer	Progresso da operação (0-100).
result	AnalyzeBatchResult	Resultado da análise de documentos em lote.
resultId	string	Analise o ID do resultado da operação em lote.
status	DocumentIntelligenceOperationStatus	Estado da operação. notIniciado, em execução, bem-sucedido ou com falha

AnalyzeBatchOperationDetail

Detalhes da operação de um documento em uma análise de lote.

Name	Tipo	Description
error	DocumentIntelligenceError	Erro encontrado.
resultUrl	string	URL do resultado da análise JSON.
sourceUrl	string	URL do documento de origem.
status	DocumentIntelligenceOperationStatus	Analise o status. bem-sucedido, reprovado ou ignorado

AnalyzeBatchResult

Resultado da análise de documentos em lote.

Name	Tipo	Description
details	AnalyzeBatchOperationDetail[]	Detalhes da operação para cada documento do lote.
failedCount	integer	Número de documentos que foram concluídos com status falharam.
skippedCount	integer	Número de documentos concluídos com status ignorado.
succeededCount	integer	Número de documentos concluídos com status bem-sucedidos.

DocumentIntelligenceError

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	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 por humanos do erro.
target	string	O alvo do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	DocumentIntelligenceError	Informações de erro.

DocumentIntelligenceInnerError

Um objeto que contém informações mais específicas sobre o erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

DocumentIntelligenceOperationStatus

Estado da operação.

Name	Tipo	Description
canceled	string	A operação foi cancelada.
failed	string	A operação falhou.
notStarted	string	A operação ainda não começou.
running	string	A operação está em curso.
skipped	string	A operação foi ignorada.
succeeded	string	A operação foi bem sucedida.

PagedAnalyzeBatchOperation

Coleção paginada de itens AnalyzeBatchOperation

Name	Tipo	Description
nextLink	string	O link para a próxima página de itens
value	AnalyzeBatchOperation[]	Os itens AnalyzeBatchOperation nesta página