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.

Tratamento de erros para chamadas síncronas

Se ocorrerem erros, a chamada síncrona retornará um código de status HTTP apropriado, acompanhado por:

• Código de erro: código específico que identifica o tipo de erro.
• Mensagem de erro: explicação detalhada que descreve o que é o erro.

Tratamento de erros para chamadas assíncronas

Em caso de erros, a URL resultante fornece o seguinte:

• Código de erro: código específico que identifica o tipo de erro.
• Mensagem de erro: explicação detalhada que descreve o que é o erro.

Se o operationId (retornado pela operação de início) for encontrado, a rota de resultados retornará persistentemente um status 202 (aplicável mesmo a solicitações não bem-sucedidas), e os detalhes do erro estarão no corpo da resposta.

Para obter detalhes e exemplos adicionais, consulte a documentação do Swagger.

Códigos de erros gerais

Verifique a lista de códigos de erro e suas mensagens correspondentes para falhas gerais:

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 erro de projetos do Document Understanding

Em alguns casos, uma falha relacionada aos projetos do Document Understanding pode resultar em uma mensagem de erro. O código de erro e a mensagem correspondente podem ter um dos seguintes 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.

Digitalização

Falha na digitalização devido ao erro do cliente

Em alguns casos, uma digitalização com falha devido a um erro de cliente pode resultar em uma mensagem de erro. Esse é um erro 400, que é exibido da seguinte forma: Code: [DigitizationErrorCode], Message: "DigitizationErrorMessage". O código de erro e a mensagem correspondente podem ter um dos seguintes 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."

Falha na digitalização devido ao número de páginas excedido

Se a digitalização falhar para chamadas síncronas falhar devido ao documento ter mais de cinco páginas, uma mensagem de erro será gerada. Esse é um erro 400 , que é exibido da seguinte maneira:

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

Se você encontrar esse erro, use APIs assíncronas. As APIs assíncronas são sempre recomendadas para casos de uso de produção. APIs síncronas são recomendadas apenas nas seguintes situações:

• Quando você tem certeza de que nunca terá mais de cinco páginas.
• Se você tiver apenas imagens de uma página, sem PDFs ou TIFFs.
• Ao preparar prova de conceitos ou demonstrações.

Falha na digitalização devido ao erro do servidor

Se a digitalização falhar devido a um erro de servidor, isso pode gerar uma mensagem de erro. Esse é um erro 500, que é exibido da seguinte forma: Code: [DigitizationFailedServerError], Message: Internal Server Error.

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

Trabalho de digitalização ou IdDoDocumento não encontrado

Se o trabalho de digitalização ou IdDoDocumento não for encontrado, uma mensagem de erro será gerada:

• Se você usar as APIs síncronas de Classificação ou Extração, um erro 404, Code:[DocumentIdNotFound] será exibido.
• Se você usar as APIs assíncronas para Classificação ou Extração, o resultado retornará um erro 200, Code:[DocumentIdNotFound].

Em ambas as situações, a seguinte mensagem de erro é gerada:

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).

Etapas de resolução

1. Verifique o resultado da chamada de digitalização /digitization/result/{documentId}.
2. Tente novamente o processo de digitalização.
3. Depois que o novo ID do documento for gerado a partir da nova tentativa, use-o para classificar e extrair dados.

Classificação

Códigos de erro de classificação

Em alguns casos, uma falha relacionada à classificação pode resultar em uma mensagem de erro. Esse é um erro, que é exibido da seguinte maneira: Code: [ClassifierErrorCode], Message: "ClassifierErrorMessage". O código de erro e a mensagem correspondente podem ter um dos seguintes 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.

Extração

Códigos de erro de extração

Em alguns casos, uma falha relacionada à extração pode resultar em uma mensagem de erro. Esse é um erro, que é exibido da seguinte maneira: Code: [ExtractorErrorCode], Message: "ExtractorErrorMessage". O código de erro e a mensagem correspondente podem ter um dos seguintes 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.

Validação

Códigos de erro do Orchestrator

Em alguns casos, uma falha relacionada ao Orchestrator pode resultar em uma mensagem de erro. O código de erro e a mensagem correspondente podem ter um dos seguintes 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 erro de validação

Em alguns casos, uma falha relacionada à validação pode resultar em uma mensagem de erro. Esse é um erro, que é exibido da seguinte maneira: Code: [ValidationErrorCode], Message: "ValidationErrorMessage". O código de erro e a mensagem correspondente podem ter um dos seguintes 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.