Document Models - List Analyze Batch Results

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Listar resultados da análise de documentos em lote.

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults?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.
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

Nome	Tipo	Description
200 OK	PagedAnalyzeBatchOperation	A solicitação foi bem-sucedida.
Other Status Codes	DocumentIntelligenceErrorResponse	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

List Analyze Batch Documents Results

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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

Nome	Description
AnalyzeBatchOperation	Status e resultado da operação de análise de lote.
AnalyzeBatchOperationDetail	Detalhes da operação de um documento em uma análise em lote.
AnalyzeBatchResult	Resultado da análise do documento 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	Status da operação.
PagedAnalyzeBatchOperation	Coleção de páginas de itens AnalyzeBatchOperation

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	DocumentIntelligenceError	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	AnalyzeBatchResult	Resultado da análise do documento em lote.
resultId	string	Analise a ID do resultado da operação em lote.
status	DocumentIntelligenceOperationStatus	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	DocumentIntelligenceError	Erro encontrado.
resultUrl	string	URL do JSON do resultado da análise.
sourceUrl	string	URL do documento de origem.
status	DocumentIntelligenceOperationStatus	Analisar o status. bem-sucedido, com falha ou ignorado

AnalyzeBatchResult

Resultado da análise do documento em lote.

Nome	Tipo	Description
details	AnalyzeBatchOperationDetail[]	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	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 pelo ser humano do erro.
target	string	O destino do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

Nome	Tipo	Description
error	DocumentIntelligenceError	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	DocumentIntelligenceInnerError	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.

PagedAnalyzeBatchOperation

Coleção de páginas de itens AnalyzeBatchOperation

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