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.

Bearbeiten von Fehlern für Synchronisierungsaufrufe

Wenn Fehler auftreten, gibt der synchrone Aufruf einen entsprechenden HTTP-Statuscode zurück, zusätzlich zu:

• Fehlercode: Spezifischer Code, der den Fehlertyp identifiziert.
• Fehlermeldung: Detaillierte Erklärung, die beschreibt, worum es bei dem Fehler geht.

Bearbeiten von Fehlern für asynchrone Aufrufe

Im Falle von Fehlern stellt die resultierende URL Folgendes bereit:

• Fehlercode: Spezifischer Code, der den Fehlertyp identifiziert.
• Fehlermeldung: Detaillierte Erklärung, die beschreibt, worum es bei dem Fehler geht.

Wenn die operationId (vom Startvorgang zurückgegeben) gefunden wird, gibt die Ergebnisse-Route persistent den Status 202 zurück (gilt auch für fehlgeschlagene Anforderungen) und die Details des Fehlers befinden sich im Textkörper der Antwort.

Weitere Details und Beispiele finden Sie in der Swagger-Dokumentation.

Allgemeine Fehlercodes

Überprüfen Sie die Liste der Fehlercodes und deren entsprechende Meldungen für allgemeine Fehler:

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.

Erkennung

Fehlercodes für Document Understanding-Projekte

In einigen Fällen kann ein Fehler im Zusammenhang mit Document Understanding-Projekten zu einer Fehlermeldung führen. Der Fehlercode und die entsprechende Meldung können einen der folgenden Werte haben:

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.

Digitalisierung

Digitalisierung ist aufgrund eines Clientfehlers fehlgeschlagen

In einigen Fällen kann eine fehlgeschlagene Digitalisierung aufgrund eines Clientfehlers zu einer Fehlermeldung führen. Dies ist ein 400-Fehler, der wie folgt angezeigt wird: Code: [DigitizationErrorCode], Message: "DigitizationErrorMessage". Der Fehlercode und die entsprechende Meldung können einen der folgenden Werte haben:

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

Digitalisierung ist fehlgeschlagen, da die Anzahl der Seiten überschritten wurde

Wenn die Digitalisierung für synchrone Aufrufe fehlgeschlagen ist, weil das Dokument mehr als fünf Seiten hat, wird eine Fehlermeldung generiert. Es handelt sich um einen 400 -Fehler, der wie folgt angezeigt wird:

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

Wenn dieser Fehler auftritt, verwenden Sie asynchrone APIs. Asynchrone APIs werden immer für Anwendungsfälle in der Produktion empfohlen. Synchrone APIs werden nur in den folgenden Situationen empfohlen:

• Wenn Sie sicher sind, dass Sie nie mehr als fünf Seiten haben werden.
• Wenn Sie nur einseitige Bilder haben, keine PDFs oder TIFFs.
• Bei der Vorbereitung von Proof-of-Concepts oder Demos.

Digitalisierung ist aufgrund eines Serverfehlers fehlgeschlagen

Wenn die Digitalisierung aufgrund eines Serverfehlers fehlgeschlagen ist, kann eine Fehlermeldung generiert werden. Dies ist ein 500-Fehler, der wie folgt angezeigt wird: Code: [DigitizationFailedServerError], Message: Internal Server Error.

Wenn dieser Fehler auftritt, empfehlen wir, sich an das UiPath®- Supportteam zu wenden.

Digitalisierungsauftrag oder DokumentID nicht gefunden

Wenn der Digitalisierungsauftrag oder die DokumentID nicht gefunden wird, wird eine Fehlermeldung generiert:

• Wenn Sie die synchronen APIs für die Klassifizierung oder Extraktion verwenden, wird der Fehler 404, Code:[DocumentIdNotFound] angezeigt.
• Wenn Sie die asynchronen APIs für die Klassifizierung oder Extraktion verwenden, wird das Abfrageergebnis den Fehler 200, Code:[DocumentIdNotFound] zurückgeben.

In beiden Situationen wird die folgende Fehlermeldung generiert:

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

Lösungsschritte

1. Überprüfen Sie das Ergebnis der Digitalisierung, indem Sie /digitization/result/{documentId} aufrufen.
2. Wiederholen Sie den Digitalisierungsprozess.
3. Sobald die neue Dokument-ID aus der Wiederholung generiert wurde, verwenden Sie sie zum Klassifizieren und Extrahieren von Daten.

Klassifizierung

Klassifizierungsfehlercodes

In einigen Fällen kann ein Fehler im Zusammenhang mit der Klassifizierung zu einer Fehlermeldung führen. Dies ist ein Fehler, der wie folgt angezeigt wird: Code: [ClassifierErrorCode], Message: "ClassifierErrorMessage". Der Fehlercode und die entsprechende Meldung können einen der folgenden Werte haben:

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.

Extraktion

Fehlercodes für Extraktion

In einigen Fällen kann ein Fehler im Zusammenhang mit der Extraktion zu einer Fehlermeldung führen. Dies ist ein Fehler, der wie folgt angezeigt wird: Code: [ExtractorErrorCode], Message: "ExtractorErrorMessage". Der Fehlercode und die entsprechende Meldung können einen der folgenden Werte haben:

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.

Validierung

Orchestrator-Fehlercodes

In einigen Fällen kann ein Fehler im Zusammenhang mit dem Orchestrator zu einer Fehlermeldung führen. Der Fehlercode und die entsprechende Meldung können einen der folgenden Werte haben:

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.

Validierungsfehlercodes

In einigen Fällen kann ein Fehler im Zusammenhang mit der Validierung zu einer Fehlermeldung führen. Dies ist ein Fehler, der wie folgt angezeigt wird: Code: [ValidationErrorCode], Message: "ValidationErrorMessage". Der Fehlercode und die entsprechende Meldung können einen der folgenden Werte haben:

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.