Content |
Content extraction result.
Namespace: OpenDiscoverSDK.Interfaces
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)
SyntaxC#
[DataContractAttribute] public enum ContentResult
Members| Member name | Value | Description |
|---|---|---|
| Ok | 0 | Success |
| UnsupportedError | 1 | Unsupported document type. |
| DataError | 2 | Data error has occured. This error is usually associated with corrupt documents. |
| CrcError | 3 | CRC error has occured |
| UnavailableError | 4 | Unavailable error. |
| UnexpectedEndError | 5 | Unexpected end to document. |
| DataAfterEndError | 6 | Archive has data after end error. |
| IsNotArchiveError | 7 | Archive processing error, document is not an archive. |
| HeaderError | 8 | Document header error. |
| WrongPassword | 9 | Wrong password. |
| EmptyFile | 100 | Document has no content because it is an empty file (0 bytes in length). |
| UnsupportedEncryptionAlg | 110 | Content extractor does not support this encryption algorithm. |
| ContainerExtractionError | 120 | Error extracting document from parent container. |
| SolidArchiveExtractionError | 130 | Error extracting document from a solid block compressed archive. |
| LanguageIdentificationError | 140 | Error identifying languages in extracted text |
| EmbeddedObjExtractError | 150 | Error extracting embedded object or embedded media. |
| MetadataExtractError | 160 | Error extracting document metadata. |
| NullStreamArgument | 170 | Null document Stream argument. |
| EntityCheckError | 180 | Entity item check error. An error occurred during entity detection. |
| AccessDeniedError | 200 | Access denied permissions error to file or folder. |
| InitialProcessingState | 10,000 | Document is not yet processed at any level (i.e., no file format identification or content extraction). |
| FileTypeIdentificationError | 10,999 | Document file type identification error (unhandled exception). |
| ExtractorFactoryError | 11,000 | Content extractor factory error. |
| RequeueAsSeparateTask | 12,000 |
Document was not processed (except file identification and hashed) because it needs to be requeued as a special task.
Document needs to be requeued as a separate workflow task by processing engine. This result can happen to composite files like split archives found while processing a batch of documents that need to be processed together or by document formats that require special processing (for example 3rd party processing tools). |
| UserRequeueAsSeparateTask | 13,000 | Document needs to be requeued as a separate user-defined custom workflow task. For example, specific image format Id's can be specified to be 'user-defined' requeue types for a user created OCR workflow. |
| ExcludedType | 14,000 | Document was not fully processed because it is a document format type that was deemed to be excluded from processing by user defined list of Id excluded format types. |
| DocumentReadError | 15,000 | Error reading document. |
| ExtractedWriteError | 16,000 | Error writing extracted document to file store. |
| ProcessingError | 17,000 | Generic processing related exception. |
| LongRunningProcessingError | 18,000 | Processing related exception - document did not finish processing in LongProcessingDocumentCriteriaInSec seconds and with no perceivable processing work being completed in that time. |
| StackOverflowError | 18,100 | Processing related exception - document caused stack-overflow crash. |
| SelfReplicatingArchiveError | 19,000 | Processing related exception - document may be a self-replicating archive (a form of a malicious 'ZIP Bomb'). |
| MaxArchiveCompressionRatioError | 19,100 | Processing related exception - document is an archive with a very 'high' compression ratio that exceeds the user configurable maximum compression value error trigger. User should investigate errored archive as a potential malicious 'ZIP Bomb' (compression bomb). |
| MaxArchiveNestLevelError | 19,200 | Processing related exception - document is an archive whose nest level within other archive parent documents exceeds the user configurable maximum value. This error is to help protect against deeply nested archives within archives, and so on, that some forms of malicious 'ZIP-Bombs' (compression bomb) use to hide their true expansion size. |
| SplitArchiveOrphanError | 19,300 | Split (multi-part) archive part does not have complete set of sibling parts for processing. |
| MimePartialOrphanError | 19,400 | MIME-partial (multi-part) part does not have a complete set of sibling parts for processing. |
| NonProcessedDuplicate | 21,000 | Document is a binary or content hash duplicate of another document that was chosen as the parent duplicate of 2 or more duplicate documents. Since the parent duplicate was processed, the child duplicate documents do not get further processed but marked with this 'NonProcessedDuplicate' result. The duplicate relationship between these documents should be maintained in any document store that stores processing results. |
| MissingDataArchiveRecordError | 22,000 | Document's record is missing from the temporary document data archive (.dda) file. |
| NistError | 23,000 | Error checking the document against the NIST database. |
| NativeAttachmentSaveError | 24,000 | Error saving an extracted native attachment/embedded child document as a file. |
| RequeueAsOCRTask | 25,000 | Document was marked as requiring OCR and it needs to be requeued as a special OCR task. |
| OCRError | 26,000 | Optical Character Recognition (OCR) related exception. |
| BelowOCRImageMinSizeCriteria | 26,001 | Image was not OCR'ed due to minimum allowable image size [pixels] criteria. |
| AboveOCRImageMaxSizeCriteria | 26,002 | Image was not OCR'ed due to maximum allowable image size [pixels] criteria. |
| LicenseExpiredError | 99,999 | License expired error. |
RemarksThe fields marked with "RESERVED" at the beginning of their summaries, integer values greater than 10000 (but less than 100000), are reserved for Open Discover Platform** namespace classes and for customers that build their own custom document processing engines upon Open Discover SDK.
The ContentResult enum members are backed by a unique, unchanging Int32 value. Int32 values between 1 and 100000 are reserved by SDK for future additions. If you wish to create your own Int32 based results to extend upon these values, then start with Int32 values greater than 100000.
** Due to its complexity, SDK built Open Discover Platform is only available to select customers.
See Also