Document Understanding Cloud API のエラー応答コード

Document Understanding^TM Cloud API では、ユース ケースに応じて、同期と非同期の 2 種類の呼び出しを使用できます。

このページでは、Document Understanding^TM Cloud API に関する一般的な問題について概説します。

同期呼び出しのエラー処理

エラーが発生した場合、同期呼び出しは以下の情報を伴う適切な HTTP ステータス コードを返します。

• エラー コード: エラーの種類を識別する特定のコード。
• エラー メッセージ: エラーの内容を説明する詳細な説明。

非同期呼び出しのエラー処理

エラーの場合、結果の URL に次の情報が表示されます。

• エラー コード: エラーの種類を識別する特定のコード。
• エラー メッセージ: エラーの内容を説明する詳細な説明。

operationId (開始操作によって返される) が見つかった場合、結果ルートは永続的に 202 ステータス (失敗した要求にも適用可能) を返し、エラーの詳細は応答の本文に含まれます。

詳細と具体例については、Swagger のドキュメントをご覧ください。

一般的なエラー コード

一般的なエラーコードとそれに対応するメッセージのリストを確認します 障害：

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

Document Understanding プロジェクトのエラー コード

場合によっては、Document Understanding プロジェクトに関連するエラーにより、 エラーメッセージ。 エラー コードと対応するメッセージには、 次 価値観：

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.

デジタル化

クライアント エラーによりデジタル化に失敗する

場合によっては、クライアント エラーが原因でデジタル化に失敗すると、エラー メッセージが表示されることがあります。これは 400 エラーで、Code: [DigitizationErrorCode], Message: "DigitizationErrorMessage" のように表示されます。エラー コードと対応するメッセージは、次のいずれかの値になります。

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

ページ数が超過したためデジタル化に失敗した

ドキュメントが 5 ページを超えることが原因で同期呼び出しのデジタル化に失敗した場合、エラー メッセージが生成されます。 これは 400 エラーで、次のように表示されます。

Code: [SyncMaximumNumberOfPagesExceeded], Message: Maximum Number Of Pages Exceeded です。

このエラーが発生した場合は、非同期 API を使用してください。運用環境のユース ケースでは、非同期 API の使用が常に推奨されます。同期 API の使用は、以下の状況でのみ推奨されます。

• ドキュメントのページ数が 5 ページを確実に超えない場合
• PDF や TIFF ではない、単一ページの画像しかない場合
• 概念実証やデモの準備を行う場合

サーバー エラーによりデジタル化に失敗する

サーバー エラーが原因でデジタル化に失敗した場合、エラー メッセージが生成されることがあります。これは 500 エラーで、Code: [DigitizationFailedServerError], Message: Internal Server Error のように表示されます。

このエラーが発生した場合は、UiPath® のサポート チームに連絡することをお勧めします。

デジタル化ジョブまたはドキュメント ID が見つからない

デジタル化ジョブまたはドキュメント ID が見つからない場合、次のエラー メッセージが生成されます。

• 分類同期 API または抽出同期 API のいずれかを使用する場合は、404, Code:[DocumentIdNotFound] エラーが表示されます。
• 分類または抽出のいずれかに非同期 API を使用する場合は、get result により 200, Code:[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).

解決手順

1. /digitization/result/{documentId} を呼び出して、デジタル化の結果を確認します。
2. デジタル化プロセスをリトライします。
3. リトライから新しいドキュメント ID が生成されたら、それを使用してデータを分類および抽出します。

分類

分類エラー コード

場合によっては、分類に関連するエラー メッセージが表示されることがあります。 このエラーは、「 Code: [ClassifierErrorCode], Message: "ClassifierErrorMessage"」のように表示されます。 エラー コードとそれに対応するメッセージには、次のいずれかの値を指定できます。

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.

生成 AI 分類器のエラー コード

場合によっては、生成 AI 分類器に関連するエラーによって、エラー メッセージが表示されることがあります。 このエラーは、「 Code: [GptClassifierErrorCode], Message: "GptClassifierErrorMessage"」のように表示されます。 エラー コードとそれに対応するメッセージには、次のいずれかの値を指定できます。

GptClassifierPromptDescriptionLengthError - Prompts required for generative classification are invalid. Please provide description of maximum 2000 characters.
GptClassifierPromptNameLengthError - Prompts required for generative classification are invalid. Please provide names of minimum 1 characters and maximum 50 characters.
GptClassifierMissingPromptsError - Prompts are required for generative classification. Please provide a set of prompts composed of name and description.
GptClassifierTooManyPromptsError - The list of prompts provided is too large. Please provide a set of maximum 50 prompts composed of name and description.
GptClassifierDuplicatePromptNamesError - Prompts required for generative classification must be unique. Please provide a set of unique prompts composed of name and description.
GptClassifierUnavailableError - The generative classifier is not available at the moment. Check the status and try again.
GptClassifierForbiddenError - Generative classification capabilities are disabled.
GptClassifierContentFilteredError - The generative classifier identified filtered content. Check the document and try again.
GptClassifierInvalidInputError - The generative classifier requires valid prompts. Check the prompts and try again.
InvalidGptClassifierMissingPromptInput - Prompts are required for validation of generative classification. Please provide a set of prompts composed of name and description.
InvalidGptClassifierTooManyPromptInput - The list of prompts provided for validation of generative classification is too large. Please provide a set of maximum 50 prompts composed of name and description.
InvalidGptClassifierDuplicatePromptNameInput - Prompts required for validation of generative classification must be unique. Please provide a set of unique prompts composed of name and description.
InvalidGptClassifierPromptNameLengthError - Prompts required for validation of generative classification are invalid. Please provide names of minimum 1 characters and maximum 50 characters.

抽出

抽出エラーコード

場合によっては、抽出に関連するエラー メッセージが表示されることがあります。 これは、 エラーが表示されます。Code: [ExtractorErrorCode], Message: "ExtractorErrorMessage"エラー コードとそれに対応するメッセージによって、 以下のいずれかを持っている 価値観：

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.

生成 AI 抽出器のエラー コード

場合によっては、生成 AI 抽出器に関連するエラーによって、エラー メッセージが表示されることがあります。 このエラーは、「 Code: [GptExtractorErrorCode], Message: "GptExtractorErrorMessage"」のように表示されます。 エラー コードとそれに対応するメッセージには、次のいずれかの値を指定できます。

GptExtractorMissingPromptsError - Prompts are required for generative extraction. Please provide a set of prompts composed of id and question.
GptExtractorTooManyPromptsError - The list of prompts provided is too large. Please provide a set of maximum 150 prompts composed of id and question.
GptExtractorPromptQuestionLengthError - Prompts required for generative extraction are invalid. Please provide questions of minimum 3 characters and maximum 1000 characters.
GptExtractorMissingIdPromptError - Prompts required for generative extraction must have an id. Please provide a set of prompts composed of id and question.
GptExtractorDuplicatePromptIdsError - Prompts required for generative extraction must have a unique id. Please provide a set of unique prompts composed of id and question.
GptExtractorDuplicatePromptQuestionsError - Prompts required for generative extraction must have a unique question. Please provide a set of unique prompts composed of id and question.
GptExtractorUnavailableError - The generative extractor is not available at the moment. Try again later.
GptExtractorForbiddenError - Generative extraction capabilities are disabled.
GptExtractorContentFilteredError - The generative extractor identified filtered content. Check the document and try again.
GptExtractorInvalidInputError - The generative extractor requires valid prompts. Check the prompts and try again.
GptNotFoundError - LLMGateway not found in the organization or tenant. Check if generative features are disabled by AI Trust Layer or if they are available in your region.
GptGenAIDisabledError - Generative AI is disabled.
GptForbiddenError - User is forbidden by governance policy to use documentunderstanding.
GptExtractorDocumentTextLengthTooShortError - Document text should have minimum 10 characters. Check the document and try again.
InvalidGptExtractorMissingPromptsInput - Prompts are required for validation of generative extraction. Please provide a set of prompts composed of id and question.
InvalidGptExtractorTooManyPromptsInput - The list of prompts provided for validation of generative extraction is too large. Please provide a set of maximum 150  prompts composed of id and question.
InvalidGptExtractorMissingPromptIdInput - Prompts required for validation of generative extraction must have an id. Please provide a set of prompts composed of id and question.
InvalidGptExtractorDuplicatePromptIdsInput - Prompts required for validation of generative extraction must have a unique id. Please provide a set of unique prompts composed of id and question.
InvalidGptExtractorPromptsNotExtractedInput - Prompts required for validation of generative extraction must be the prompts used for generative extraction. Please provide a set of prompts composed of id and question that were used for generative extraction.
CannotSetAllowDocumentTypeChangeForGenerative - Cannot set allowChangeOfDocumentType defaulted to true when using the generative extractor, as there are no Document Types to be referenced.

検証

Orchestrator のエラー コード

場合によっては、Orchestrator に関連する障害によってエラー メッセージが表示されることがあります。 エラー code とそれに対応するメッセージには、次のいずれかが含まれます 価値観：

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.

検証エラー コード

場合によっては、検証に関連するエラーによってエラー メッセージが表示されることがあります。 これは、 エラーが表示されます。Code: [ValidationErrorCode], Message: "ValidationErrorMessage"エラー コードとそれに対応するメッセージによって、 以下のいずれかを持っている 価値観：

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.