Document Models - List Analyze Batch Results

Servicio:

Azure AI Services

Versión de la API:

2024-11-30

Enumerar los resultados del análisis de documentos por lotes.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string uri	Punto de conexión del servicio De inteligencia de documentos.
modelId	path	True	string	Nombre único del modelo de documento. Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	PagedAnalyzeBatchOperation	La solicitud se ha realizado correctamente.
Other Status Codes	DocumentIntelligenceErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

List Analyze Batch Documents Results

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
AnalyzeBatchOperation	Estado y resultado de la operación de análisis por lotes.
AnalyzeBatchOperationDetail	Detalles de la operación de un documento en un análisis por lotes.
AnalyzeBatchResult	Resultado del análisis de documentos por lotes.
DocumentIntelligenceError	Objeto de error.
DocumentIntelligenceErrorResponse	Objeto de respuesta de error.
DocumentIntelligenceInnerError	Objeto que contiene información más específica sobre el error.
DocumentIntelligenceOperationStatus	Estado de la operación.
PagedAnalyzeBatchOperation	Colección paginada de elementos AnalyzeBatchOperation

AnalyzeBatchOperation

Estado y resultado de la operación de análisis por lotes.

Nombre	Tipo	Description
createdDateTime	string	Fecha y hora (UTC) cuando se envió la operación.
error	DocumentIntelligenceError	Error durante el análisis de documentos por lotes.
lastUpdatedDateTime	string	Fecha y hora (UTC) cuando se actualizó por última vez el estado.
percentCompleted	integer	Progreso de la operación (0-100).
result	AnalyzeBatchResult	Resultado del análisis de documentos por lotes.
resultId	string	Analice el identificador de resultado de la operación por lotes.
status	DocumentIntelligenceOperationStatus	Estado de la operación. notStarted, running, succeeded o failed

AnalyzeBatchOperationDetail

Detalles de la operación de un documento en un análisis por lotes.

Nombre	Tipo	Description
error	DocumentIntelligenceError	Error encontrado.
resultUrl	string	Dirección URL del json del resultado de análisis.
sourceUrl	string	Dirección URL del documento de origen.
status	DocumentIntelligenceOperationStatus	Analice el estado. correcto, erróneo o omitido

AnalyzeBatchResult

Resultado del análisis de documentos por lotes.

Nombre	Tipo	Description
details	AnalyzeBatchOperationDetail[]	Detalles de la operación para cada documento del lote.
failedCount	integer	Número de documentos completados con error de estado.
skippedCount	integer	Número de documentos que se completaron con el estado omitido.
succeededCount	integer	Número de documentos que se completaron con el estado correcto.

DocumentIntelligenceError

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	DocumentIntelligenceError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	DocumentIntelligenceInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

DocumentIntelligenceErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	DocumentIntelligenceError	Información de error.

DocumentIntelligenceInnerError

Objeto que contiene información más específica sobre el error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	DocumentIntelligenceInnerError	Error interno.
message	string	Representación legible del error.

DocumentIntelligenceOperationStatus

Estado de la operación.

Nombre	Tipo	Description
canceled	string	Se ha cancelado la operación.
failed	string	Error en la operación.
notStarted	string	La operación aún no se ha iniciado.
running	string	La operación está en curso.
skipped	string	Se ha omitido la operación.
succeeded	string	La operación se ha realizado correctamente.

PagedAnalyzeBatchOperation

Colección paginada de elementos AnalyzeBatchOperation

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de elementos
value	AnalyzeBatchOperation[]	Elementos AnalyzeBatchOperation de esta página