Document
A document in Ocrolus is a key element that includes several important attributes to ensure comprehensive tracking and processing. Each document has a unique identification number called pk
or uuid
. It is an essential element to identify a document within a Book. The name
attribute represents the filename of the document whereas the page_count
indicates the total number of pages in the document.
Similarly, the status
attribute shows the current processing status of the document to understand whether it has been processed successfully or if there are any issues. For additional security and integrity checks, the md5
attribute contains the MD5 checksum of the file to ensure that the document has not been altered. If a document is rejected, the rejection_reason
attribute will show the cause of why the document was not accepted.
Attribute | Data type | Description |
---|---|---|
pk | PK | Unique identification number of the Book. |
name | Text | Filename of Document |
page_count | Integer | Total pages in a Document |
status | Document Status | Processing status of Document |
md5 | Text | MD5 Checksum of file |
rejection_reason | Text | Reason why a Document was rejected. Only present when Document status = REJECTED . |
Updated 3 months ago