OcrJobRead
object
Reads an OCR job
Provider details (provider, externalJobId, raw provider response) are intentionally
never exposed.
Fields
| Name | Type | Description |
|---|---|---|
ocrJobId | String! | Please note that this value is a String (UUID) and not an Integer |
status | OcrJobStatusEnum! | |
originalFileName | String! | Original file name of the scanned document |
documentId | Int | Set once a draft document has been created from this job |
document | DocumentRead | The draft document created from this job; null until `documentId`is set |
msg | String | Failure message (generic), when status is failed |
documentErrors | [String!] | Specific document-generation error messages (there can be more than one), shown beneath `msg`. Each is a source string the client translates; null when generation never failed. |
suggestions | JSON | Review-time suggestions, set once a draft document is created (empty placeholder for now) |
aiFilledData | JSON | What was pre-filled into the draft document, set once it is created (empty placeholder for now) |
deletable | Boolean! | True when the job can be deleted (i.e. it has finished — status ready or failed) |
canRetry | Boolean! | True when the job can be retried: it failed before OCR produced any result |
canCreateDocument | Boolean! | True when a document can be created from this job: it failed after OCR produced a result |
canDownloadFile | Boolean! | True when the original scanned file can be downloaded: both its stored path and filename are present |
createdAt | DateTime | |
updatedAt | DateTime |