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.

Gestion des erreurs pour les appels de synchronisation

Si des erreurs se produisent, l’appel synchrone renverra un code de statut HTTP approprié, accompagné des éléments suivants :

• Code d’erreur : code spécifique qui identifie le type d’erreur.
• Message d’erreur : explication détaillée qui décrit l’erreur.

Gestion des erreurs pour les appels asynchrones

En cas d’erreurs, l’URL qui en résulte fournit les éléments suivants :

• Code d’erreur : code spécifique qui identifie le type d’erreur.
• Message d’erreur : explication détaillée qui décrit l’erreur.

Si l’objet operationId (renvoyé par l’opération de démarrage) est trouvé, la route des résultats renverra de manière persistante un statut 202 (applicable même aux requêtes infructueuses) et les détails de l’erreur figureront dans le corps de la réponse.

Pour plus de détails et d’exemples, consultez la documentation Swagger.

Codes d'erreur généraux

Consultez la liste des codes d'erreur et leurs messages correspondants pour les échecs généraux :

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.

Découverte

Codes d'erreur des projets Document Understanding

Dans certains cas, un échec lié à des projets Document Understanding peut entraîner un message d’erreur. Le code d’erreur et le message correspondant peuvent avoir l’une des valeurs suivantes :

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.

Numérisation

Échec de la numérisation en raison d’une erreur client

Dans certains cas, un échec de numérisation en raison d’une erreur client peut entraîner un message d’erreur. Il s’agit d’une erreur 400, qui s’affiche comme suit : Code: [DigitizationErrorCode], Message: "DigitizationErrorMessage". Le code d’erreur et le message correspondant peuvent avoir l’une des valeurs suivantes :

[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."

La numérisation a échoué en raison du nombre de pages dépassé

Si la numérisation pour les appels synchrones a échoué car le document comporte plus de cinq pages, un message d’erreur est généré. Il s’agit d’une erreur 400, qui s’affiche comme suit :

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

Si vous rencontrez cette erreur, utilisez des API asynchrones. Les API asynchrones sont toujours recommandées pour les cas d'utilisation de production. Les API synchrones ne sont recommandées que dans les situations suivantes :

• Lorsque vous êtes certain que vous n'aurez jamais plus de cinq pages.
• Si vous n'avez que des images d'une seule page, pas de fichier PDF ou TIFF.
• Lors de la préparation de preuves de concept ou de démonstrations.

Échec de la numérisation en raison d’une erreur serveur

Si la numérisation a échoué en raison d’une erreur serveur, cela peut générer un message d’erreur. Il s’agit d’une erreur 500, qui s’affiche comme suit : Code: [DigitizationFailedServerError], Message: Internal Server Error.

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

Tâche de numérisation ou ID de document introuvable

Si la tâche de numérisation ou l’ID du document est introuvable, un message d’erreur est généré :

• Si vous utilisez les API synchrones de classification ou d’extraction, une erreur 404, Code:[DocumentIdNotFound] s’affiche.
• Si vous utilisez les API asynchrones pour la classification ou l’extraction, la requête GET renverra une erreur 200, Code:[DocumentIdNotFound].

Dans les deux cas, le message d’erreur suivant est généré :

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

Étapes de résolution

1. Vérifiez le résultat de la numérisation appelant /digitization/result/{documentId}.
2. Réessayez le processus de numérisation.
3. Une fois le nouvel ID de document généré lors de la nouvelle tentative, utilisez-le pour classer et extraire les données.

Classification

Codes d'erreur de classification

Dans certains cas, un échec lié à la classification peut entraîner un message d’erreur. Il s’agit d’une erreur, qui s’affiche comme suit : Code: [ClassifierErrorCode], Message: "ClassifierErrorMessage". Le code d’erreur et le message correspondant peuvent avoir l’une des valeurs suivantes :

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.

Extraction

Codes d'erreur d'extraction

Dans certains cas, un échec lié à l’extraction peut entraîner un message d’erreur. Il s’agit d’une erreur, qui s’affiche comme suit : Code: [ExtractorErrorCode], Message: "ExtractorErrorMessage". Le code d’erreur et le message correspondant peuvent avoir l’une des valeurs suivantes :

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.

Validation

Codes d'erreur d'Orchestrator

Dans certains cas, un échec lié à Orchestrator peut entraîner un message d’erreur. Le code d’erreur et le message correspondant peuvent avoir l’une des valeurs suivantes :

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.

Codes d'erreur de validation

Dans certains cas, un échec lié à la validation peut entraîner un message d’erreur. Il s’agit d’une erreur, qui s’affiche comme suit : Code: [ValidationErrorCode], Message: "ValidationErrorMessage". Le code d’erreur et le message correspondant peuvent avoir l’une des valeurs suivantes :

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.