document-understanding
latest
false
- Getting Started
- Examples Using the Document Understanding™ Cloud API
- Licensing
- Troubleshooting
- Requests response schemas
- Document Understanding Cloud APIs error response codes
Document Understanding API Guide
Last updated Nov 21, 2024
Document Understanding Cloud APIs error response codes
Depending on your use case, you can use two types of calls for Document UnderstandingTM Cloud APIs: synchronous (sync) and asynchronous (async).
Common issues concerning Document UnderstandingTM Cloud APIs are outlined in this page.
If errors occur, the synchronous call will return an appropriate HTTP status code,
accompanied by:
- Error Code: specific code that identifies the type of error.
- Error Message: detailed explanation that describes what the error is about.
In case of errors, the resulting URL provides the following:
- Error Code: specific code that identifies the type of error.
- Error Message: detailed explanation that describes what the error is about.
If the
operationId (returned by the start operation) is found, the
results route will persistently return a 202 status (applicable
even to unsuccesful requests) and the details of the error will be in the body of
the response.
For additional details and examples, check the Swagger documentation.
If the digitization job or DocumentId is not found, an error message is generated:
- If you use either the Classification or Extraction synchronous APIs, a
404, Code:[DocumentIdNotFound]error is displayed. - Is you use the asynchronous APIs for either Classification or Extraction, the get
result will return a
200, Code:[DocumentIdNotFound]error.
In both situation, the following error message is generated:
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).
In some cases, a failed digitization due to a client error may result in an error
message. This is a
400 error, which is displayed as follows:
Code: [DigitizationErrorCode], Message: "DigitizationErrorMessage".
The error code and the corresponding message can have one of the following values:
[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."[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."If digitization failed due to a server error, this can generate an error message. This is
a
500 error, which is displayed as follows: Code:
[DigitizationFailedServerError], Message: Internal Server Error.
If you encounter this error, we recommend contacting the UiPath® Support team.
If digitization failed for synchronous calls failed due to the document having more than
five pages, an error message is generated. This is a
400 error, which
is displayed as follows: Code: [SyncMaximumNumberOfPagesExceeded], Message:
Maximum Number Of Pages Exceeded.
If you encounter this error, use asysnchronous APIs. Asynchronous APIs are always
recommended for production use cases. Synchronous APIs are only recommended in the
following situations:
- When you are certain that you will never have more than five pages.
- If you only have single-page images, no PDFs or TIFFs.
- When preparing proof of concepts or demos.
