Document Understanding APIs error response codes

Depending on your use case, you can use two types of calls for Document Understanding^TM APIs: synchronous (sync) and asynchronous (async).

Common issues concerning Document Understanding^TM APIs are outlined in this page.

Gestionar errores para las llamadas de sincronización

Si se producen errores, la llamada síncrona devolverá un código de estado HTTP adecuado, acompañado por:

• Código de error: código específico que identifica el tipo de error.
• Mensaje de error: explicación detallada que describe de qué se trata el error.

Gestionar errores para llamadas asíncronas

En caso de errores, la URL resultante proporciona lo siguiente:

• Código de error: código específico que identifica el tipo de error.
• Mensaje de error: explicación detallada que describe de qué se trata el error.

Si se encuentra el operationId (devuelto por la operación de inicio), la ruta de resultados devolverá persistentemente un 202 estado (aplicable incluso a solicitudes no correctas) y los detalles del error estarán en el cuerpo de la respuesta.

Para obtener más detalles y ejemplos adicionales, consulta la documentación de Swagger.

Códigos de error generales

Consulta la lista de códigos de error y sus mensajes correspondientes para fallos generales:

OperationIdNotFoundError - Operation Id not found.
DatabaseConcurrencyError - Unable to update job status for the given input.
RequestAbortedByClient - Request aborted by client
TooManyRequests - Rate limit exceeded. Try again later. For details around the applicable limitations, check out the official documentation.
DeploymentUnavailableError - The project version this resource is part of is not available. Please check the project deployment version status and try again.
DeploymentTagNotFoundError - There is no project version tag that matches your request.
DeploymentDocumentTypeNotFoundError - The requested project version deployment does not contain an extraction model for the requested document type.
UnexpectedInternalServerError - Internal Server Error. Please contact the UiPath support team.
ServiceUnavailableError - Service Unavailable. Please retry in a few moments.

Discovery

Códigos de error de proyectos de Document Understanding

En algunos casos, un fallo relacionado con los proyectos de Document Understanding puede dar lugar a un mensaje de error. El código de error y el mensaje correspondiente pueden tener uno de los siguientes valores:

DiscoveryResourceNotFoundError - Resource not found.
DuCenterProjectNotFound - Du Center project not found.
DocumentIdNotFound - Cannot perform the operation for the given documentId: Ensure it is correct, the digitization is successful (retrieving the digitization result), and not more than 7 days since the digitization call passed (case in which, it expired).
DocumentIdInvalid - Required input DocumentId is missing or invalid.
DocumentTypeIdNotFound - Document Type Id not found in the given project.
ProjectVersionNotSupportedError - Project Version is not supported for classic projects.
ModernProjectExtractorRequestTooLargeError - Maximum number of pages per document exceeded for the given custom trained extractor.

Digitalización

La digitalización falló debido a un error del cliente

En algunos casos, una digitalización fallida debido a un error del cliente puede dar como resultado un mensaje de error. Este es un error 400, que se muestra de la siguiente manera: Code: [DigitizationErrorCode], Message: "DigitizationErrorMessage". El código de error y el mensaje correspondiente pueden tener uno de los siguientes valores:

[UnsupportedContentTypeError]", "Content type of the input document is not supported."
[UnexpectedPdfStructureError]", "Invalid or corrupt PDF structure."
[InvalidImageSizeError]", "Image size of the input document is not supported."
[UnableToProcessContentError]", "Unable to process document contents."
[ContentTypeMismatchError]", "Declared content-type of the input document does not match the binary content type."
[PasswordProtectedPdfError]", "Password protected PDFs are not supported."
[MaximumNumberOfPagesPerDocumentLimitExceededError]", "Maximum number of pages for digitization exceeded."
[InvalidRequestData]", "The form data in the request is invalid. Expected is a multi-part form data, with either one part consisting of the document to be digitized, or two named parts: File - the document, DigitizationResult - the digitization result, with content type application/json."
[UnexpectedDigitizationResultStructure]", "The digitization result object is invalid and non-serializable."
[InvalidDom]", "The provided DOM is invalid. Make sure the DOM is correctly built, including valid non-overlapping indices, well formed boxes and polygons and valid values for all properties."
[MismatchingDomAndContent]", "The provided DOM and content do not match. Make sure the DOM was generated on the provided document."
[MismatchingDomAndText]", "The provided DOM and text do not match. Make sure the text and DOM were generated on the same document."
[PreprocessingOptionIncompatibleWithDigitizationResult]", "Using the preprocessing option while also providing a digitization result input is not supported."
[InvalidOcrApiKeyError]", "OCR Api key is invalid."
[OcrTooManyRequestsError]", "OCR request quota exceeded."
[ExternalOcrTooManyRequestsError]", "OCR request quota exceeded."
[GoogleBillingNotEnabled]", "Google OCR billing is not enabled. Please enable billing in your Google Cloud Platform account."
[GoogleApiKeyExpired]", "Google OCR Api Key Expired."
[InvalidOcrUrlError]", "The provided OCR URL is invalid or malformed."
[InvalidResponseFromOcrEngineError]", "Invalid response received from the OCR engine. Please set another OCR engine for the project you are using."
[DigitizationFileRequired]", "Required input file(s) are missing or not packaged as a valid multipart/form-data."

Error de digitalización debido a que se ha superado el número de páginas

Si la digitalización falló para las llamadas síncronas debido a que el documento tiene más de cinco páginas, se genera un mensaje de error. Se trata de un error 400 , que se muestra de la siguiente manera:

Code: [SyncMaximumNumberOfPagesExceeded], Message: Maximum Number Of Pages Exceeded.

Si te encuentras con este error, utiliza API asíncronas. Las API asíncronas siempre se recomiendan para casos de uso de producción. Las API síncronas solo se recomiendan en las siguientes situaciones:

• Cuando esté seguro de que nunca tendrá más de cinco páginas.
• Si solo tienes imágenes de una sola página, no archivos PDF o TIFF.
• Al preparar pruebas de concepto o demostraciones.

La digitalización falló debido a un error del servidor

Si la digitalización falló debido a un error del servidor, esto puede generar un mensaje de error. Este es un error 500, que se muestra de la siguiente manera: Code: [DigitizationFailedServerError], Message: Internal Server Error.

If you encounter this error, we recommend contacting the UiPath® Support team.

Trabajo de digitalización o DocumentId no se encontró

Si no se encuentra el trabajo de digitalización o DocumentId, se genera un mensaje de error:

• Si utilizas las API síncronas de clasificación o extracción, se muestra un error 404, Code:[DocumentIdNotFound].
• Si utilizas las API asíncronas para la clasificación o la extracción, el resultado obtenido devolverá un error 200, Code:[DocumentIdNotFound].

En ambas situaciones, se genera el siguiente mensaje de error:

Cannot perform the operation for the given documentId: Ensure it is correct, the digitization is successful (retrieving the digitization result), and not more than 7 days since the digitization call passed (case in which, it expired).

Pasos de resolución

1. Comprueba el resultado de la llamada de digitalización /digitization/result/{documentId}.
2. Reintenta el proceso de digitalización.
3. Una vez que se haya generado el nuevo ID del documento a partir del reintento, utilízalo para clasificar y extraer datos.

Clasificación

Códigos de error de clasificación

En algunos casos, un fallo relacionado con la clasificación puede dar lugar a un mensaje de error. Se trata de un error, que se muestra de la siguiente manera: Code: [ClassifierErrorCode], Message: "ClassifierErrorMessage". El código de error y el mensaje correspondiente pueden tener uno de los siguientes valores:

ClassifierRequestTooLargeError - Maximum number of pages per document exceeded for the given classifier. Please use a custom trained model to process the input document.
ClassifierSyncMaximumNumberOfPagesExceeded - Maximum number of pages (5) for synchronous classification exceeded for this document. Please use the asynchronous APIs.
InvalidClassifierIdInput - The provided classifier id from the URL is different from the one in the classification result.
ClassifierIdNotFound - Classifier Id not found in the given project.
DeploymentClassifierNotFoundError - The requested project version deployment does not contain a classifier for the requested tag.
PrivateSkillClassifierUnavailable - The private skill classifier is not available at the moment. Check classifier status and try again.

Extracción

Códigos de error de extracción

En algunos casos, un fallo relacionado con la extracción puede dar lugar a un mensaje de error. Se trata de un error, que se muestra de la siguiente manera: Code: [ExtractorErrorCode], Message: "ExtractorErrorMessage". El código de error y el mensaje correspondiente pueden tener uno de los siguientes valores:

ExtractorRequestTooLargeError - Maximum number of pages per document exceeded for the given extractor. Please use a custom trained model to process the input document.
ExtractorSyncMaximumNumberOfPagesExceeded - Maximum number of pages (5) for synchronous extraction exceeded for this document. Please use the asynchronous APIs.
ExtractionAutoValidationConfidenceInvalidError - The parameter value for autovalidation Confidence is invalid. Please provide a confidence value in the 0-100 range.
ExtractionAutoValidationConfidenceInvalidGenerativeError - The autovalidation extraction confidence option is invalid for the generative extractor. Please select a different extractor and try again.
ExtractorIdNotFound - Extractor Id not found in the given project.
PrivateSkillExtractorUnavailable - The private skill extractor is not available at the moment. Check extractor status and try again.
PrivateSkillExtractorGetInfoModelCallFailedError - The private skill extractor is not available at the moment. Check extractor status and try again.
PrivateMLSkillUnavailable - The private ML Skill is not available at the moment. Check the skill configuration. Possible configuration issues might include: insufficient replica count, insufficient memory or cpu, using cpu when a gpu is more appropriate.
PublicSkillUnavailable - The public skill is not available at the moment. Check the status and try again.

Validación

Códigos de error de Orchestrator

En algunos casos, un fallo relacionado con Orchestrator puede dar lugar a un mensaje de error. El código de error y el mensaje correspondiente pueden tener uno de los siguientes valores:

OrchestratorDisabledError - The orchestrator service is not enabled for this tenant.
OrchestratorTaskCatalogNotFound - Orchestrator catalog does not exist.
OrchestratorFolderNotFoundError - Orchestrator folder does not exist.
OrchestratorBucketNotFoundError - Orchestrator bucket does not exist.
OrchestratorAssetNotFoundError - Orchestrator asset does not exist.
OrchestratorAlreadyExistsError - Orchestrator resource already exists.

Códigos de error de validación

En algunos casos, un fallo relacionado con la validación puede dar lugar a un mensaje de error. Se trata de un error, que se muestra de la siguiente manera: Code: [ValidationErrorCode], Message: "ValidationErrorMessage". El código de error y el mensaje correspondiente pueden tener uno de los siguientes valores:

ValidationTaskNotFoundError - Validation task not found in Action Center.
ValidationInvalidActionTitle - Required input ActionTitle is missing or invalid.
ValidationMaxLengthActionCatalog - Validation action catalog maximum length exceeded: 50 characters.
ValidationMaxLengthActionFolder - Validation action folder maximum length exceeded: 200 characters.
ValidationActionCatalogNotFoundError - Action Catalog not found.
InvalidOrMalformedClassificationResultInput - The provided classification result is invalid or malformed.
InvalidFieldsValidationConfidenceInput - The value set for Extracted Fields Validation Confidence is not valid. It should be an integer value between 0 and 100.
InvalidOrMalformedExtractionResultInput - The provided extraction result is invalid or malformed.
InvalidExtractorIdMismatchInput - The provided extractor id from the URL is different from the one in the extraction result.