DocumentTextExtractionFailedResponse

The body of a 422 for an uploaded file Maitento could not read usable text from, even after trying OCR where it could. The failure is permanent for that file: don’t retry the upload, show the guidance instead.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
error	string	What went wrong, in English.
category	string	The kind of failure: always DocumentTextExtractionFailed.
ocrAttempted	boolean	Whether Maitento tried reading the file with OCR (text recognition) before giving up.
guidance	string	What the person who uploaded the file can do about it, such as uploading a text-searchable PDF instead.

Example

{
  "error": "...",
  "category": "...",
  "ocrAttempted": false,
  "guidance": "..."
}