document-understanding
2024.10
true
- Primeros pasos
- Ejemplos de uso de la API de Document Understanding™
- Licencia
- Solución de problemas
- Solicita esquemas de respuesta
- Códigos de respuesta de error de las API de Document Understanding
Solicita esquemas de respuesta
Guía de la API de Document Understanding
Last updated 11 de nov. de 2024
Solicita esquemas de respuesta
El resultado que recuperamos del uso de API asíncronas puede estar en proceso, tener éxito o puede encontrar fallos. Esta página describe los esquemas devueltos comúnmente para ambas situaciones cuando se realiza una
getResult
llamada. Aprender a descifrar estos resultados es clave para la gestión de API y para solucionar con éxito los problemas.
Cuando todavía se está procesando, la llamada
getResult
devuelve un esquema con los siguientes detalles:
status
: el estado actual de la solicitud. En este caso, el estado esRunning
.createdAt
: fecha y hora en que se inició la solicitud.lastUpdatedAt
: fecha y hora en que se actualizó la solicitud por última vez.
Cuando la solicitud se realiza correctamente, la llamada
getResult
devuelve un esquema con los siguientes detalles:
status
: el estado actual de la solicitud. En este caso, el estado esSucceeded
.createdAt
: fecha y hora en que se inició la solicitud.lastUpdatedAt
: fecha y hora en que se actualizó la solicitud por última vez.result
: resultado de la solicitud, por ejemplo el resultado de la extracción (se muestra comoextractionResult
).
Cuando la solicitud falló, la llamada
getResult
devuelve un esquema con los siguientes detalles:
status
: el estado actual de la solicitud. En este caso, el estado esFailed
.createdAt
: fecha y hora en que se inició la solicitud.lastUpdatedAt
: fecha y hora en que se actualizó la solicitud por última vez.error
: la causa de los errores con los siguientes detalles:message
: explicación detallada que describe de qué se trata el error, por ejemplo,"Internal Server Error. Please contact the UiPath support team."
severity
: la gravedad del fallo. En este caso, la gravedad es más comúnmenteError
.code
: código específico que identifica el tipo de error, por ejemplo[UnexpectedInternalServerError]
.parameters
: contiene información adicional relacionada con errores, si corresponde.