API Reference
Class
OfficeDocumentReadResult
Shared result envelope for document readback workflows.
Inheritance
- Object
- OfficeDocumentReadResult
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method DelegateAsyncOfficeDocumentProcessor.ProcessAsync
- Method DelegateOfficeDocumentProcessor.Process
- Method IAsyncOfficeDocumentProcessor.ProcessAsync
- Method ISynchronousOfficeDocumentProcessor.Process
- Method OfficeDocumentArtifactClassificationProcessor.Process
- Method OfficeDocumentAssetFilterProcessor.Process
- Method OfficeDocumentBlockNormalizationProcessor.Process
- Method OfficeDocumentLinkNormalizationProcessor.Process
- Property OfficeDocumentOcrEnrichmentResult.Document
- Property OfficeDocumentOcrExecutionResult.Document
- Method OfficeDocumentOcrProcessor.ProcessAsync
- Property OfficeDocumentProcessingResult.Document
- Method OfficeDocumentProcessorBase.Process
- Method OfficeDocumentReader.ReadDocument
- Method OfficeDocumentReader.ReadDocument
- Method OfficeDocumentReader.ReadDocumentAsync
- Method OfficeDocumentReader.ReadDocumentAsync
- Method OfficeDocumentReader.ReadDocumentsAsync
- Method OfficeDocumentReadResultJson.Deserialize
- Method OfficeDocumentTableNormalizationProcessor.Process
- Property ReaderHandlerRegistration.ReadDocumentPath
- Property ReaderHandlerRegistration.ReadDocumentPathAsync
- Property ReaderHandlerRegistration.ReadDocumentStream
- Property ReaderHandlerRegistration.ReadDocumentStreamAsync
Accepted by parameters
- Constructor DelegateAsyncOfficeDocumentProcessor.DelegateAsyncOfficeDocumentProcessor
- Method DelegateAsyncOfficeDocumentProcessor.ProcessAsync
- Constructor DelegateOfficeDocumentProcessor.DelegateOfficeDocumentProcessor
- Method DelegateOfficeDocumentProcessor.Process
- Method DocumentReaderEngine.ChunkDocument
- Method DocumentReaderEngine.ExtractAssets
- Method DocumentReaderEngine.ExtractStructured
- Method IAsyncOfficeDocumentProcessor.ProcessAsync
- Method ISynchronousOfficeDocumentProcessor.Process
- Method OfficeDocumentArtifactClassificationProcessor.Process
- Method OfficeDocumentAssetDataUri.BuildAssetDataUriMap
- Method OfficeDocumentAssetFilterProcessor.Process
- Method OfficeDocumentAssetMaterializer.StreamAssets
- Method OfficeDocumentAssetMaterializer.WriteAssetsToDirectory
- Method OfficeDocumentBlockNormalizationProcessor.Process
- Method OfficeDocumentLinkNormalizationProcessor.Process
- Method OfficeDocumentOcrEnrichmentExtensions.ApplyOcrResults
- Method OfficeDocumentOcrExecutionExtensions.ApplyOcrAsync
- Method OfficeDocumentOcrProcessor.ProcessAsync
- Method OfficeDocumentProcessorBase.Process
- Method OfficeDocumentProcessorPipeline.Process
- Method OfficeDocumentProcessorPipeline.ProcessAsync
- Method OfficeDocumentReader.ChunkDocument
- Method OfficeDocumentReader.ExtractAssets
- Method OfficeDocumentReader.ExtractStructured
- Method OfficeDocumentReader.ProcessDocument
- Method OfficeDocumentReader.ProcessDocumentAsync
- Extension method OfficeDocumentReadResult.ApplyOcrAsync
- Extension method OfficeDocumentReadResult.ApplyOcrResults
- Extension method OfficeDocumentReadResult.BuildAssetDataUriMap
- Extension method OfficeDocumentReadResult.StreamAssets
- Extension method OfficeDocumentReadResult.ToJson
- Extension method OfficeDocumentReadResult.WriteAssetsToDirectory
- Method OfficeDocumentReadResultJson.Serialize
- Method OfficeDocumentReadResultJson.ToJson
- Method OfficeDocumentStructuredExtractor.Extract
- Method OfficeDocumentTableNormalizationProcessor.Process
- Method ReaderHierarchicalChunker.Chunk
Constructors
public OfficeDocumentReadResult() #Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public String SchemaId { get; set; } #Result schema identifier.
public Int32 SchemaVersion { get; set; } #Result schema version.
public ReaderInputKind Kind { get; set; } #Source input kind that produced this result.
public OfficeDocumentSource Source { get; set; } #Source document metadata used for citations and incremental processing.
public IReadOnlyList<String> CapabilitiesUsed { get; set; } #Capability identifiers used while producing this result.
public String Markdown { get; set; } #Portable Markdown representation when available.
public String Html { get; set; } #Portable or review HTML representation when available.
public String Json { get; set; } #Deterministic JSON representation when a producer emits one.
public IReadOnlyList<ReaderChunk> Chunks { get; set; } #Reader chunks produced by the same extraction run.
public IReadOnlyList<OfficeDocumentMetadataEntry> Metadata { get; set; } #Document-level metadata entries discovered during reading.
public IReadOnlyList<OfficeDocumentPage> Pages { get; set; } #Page, slide, sheet, or diagram-page records produced by document reading.
public IReadOnlyList<OfficeDocumentBlock> Blocks { get; set; } #Normalized logical blocks in source order.
public IReadOnlyList<ReaderTable> Tables { get; set; } #Structured tables extracted or detected during reading.
public IReadOnlyList<OfficeDocumentAsset> Assets { get; set; } #Images, previews, and other binary or visual assets discovered during reading.
public IReadOnlyList<OfficeDocumentLink> Links { get; set; } #Hyperlinks, internal destinations, and navigation targets discovered during reading.
public IReadOnlyList<OfficeDocumentFormField> Forms { get; set; } #Form fields or widgets discovered during reading.
public IReadOnlyList<OfficeDocumentOcrCandidate> OcrCandidates { get; set; } #Regions that likely need OCR before text extraction can be considered complete.
public IReadOnlyList<ReaderVisual> Visuals { get; set; } #Structured visual payloads discovered during reading.
public IReadOnlyList<OfficeDocumentDiagnostic> Diagnostics { get; set; } #Warnings and diagnostics emitted during reading.
Extension Methods
public static async Task<OfficeDocumentOcrExecutionResult> ApplyOcrAsync(OfficeDocumentReadResult document, IOfficeOcrEngine engine, OfficeDocumentOcrExecutionOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OfficeDocumentOcrExecutionResult>Executes an OCR engine over validated candidate assets, preserves deterministic result order, and enriches the document.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- engine OfficeIMO.Reader.IOfficeOcrEngine
- options OfficeIMO.Reader.OfficeDocumentOcrExecutionOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static OfficeDocumentOcrEnrichmentResult ApplyOcrResults(OfficeDocumentReadResult result, IEnumerable<OfficeDocumentOcrTextResult> ocrResults, OfficeDocumentOcrEnrichmentOptions options = null) #Returns:
OfficeDocumentOcrEnrichmentResultApplies recognized OCR text to a document read result without requiring the core reader to run an OCR engine.
Parameters
- result OfficeIMO.Reader.OfficeDocumentReadResult
- Source read result containing OCR candidates.
- ocrResults System.Collections.Generic.IEnumerable{OfficeIMO.Reader.OfficeDocumentOcrTextResult}
- Recognized OCR text keyed by candidate identifier.
- options OfficeIMO.Reader.OfficeDocumentOcrEnrichmentOptions = null
- Optional enrichment behavior.
Returns
An enriched read result plus observable merge counters.
public static IReadOnlyDictionary<String, String> BuildAssetDataUriMap(OfficeDocumentReadResult result, OfficeDocumentAssetDataUriOptions options = null) #Returns:
IReadOnlyDictionary<String, String>Builds a data URI map keyed by asset id for materializable assets in a read result.
Parameters
- result OfficeIMO.Reader.OfficeDocumentReadResult
- Read result that owns the assets.
- options OfficeIMO.Reader.OfficeDocumentAssetDataUriOptions = null
- Data URI options.
public static IReadOnlyList<OfficeDocumentMaterializedAsset> StreamAssets(OfficeDocumentReadResult result, Action<OfficeDocumentAsset, Stream> writeAsset, OfficeDocumentAssetMaterializationOptions options = null, CancellationToken cancellationToken = null) #Returns:
IReadOnlyList<OfficeDocumentMaterializedAsset>Streams materializable asset payloads to a caller-owned callback without writing files.
Parameters
- result OfficeIMO.Reader.OfficeDocumentReadResult
- Read result that owns the assets.
- writeAsset System.Action{OfficeIMO.Reader.OfficeDocumentAsset,System.IO.Stream}
- Callback that receives each asset and a readable payload stream.
- options OfficeIMO.Reader.OfficeDocumentAssetMaterializationOptions = null
- Materialization options.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
public static String ToJson(OfficeDocumentReadResult result, Boolean indented = false) #Returns:
StringSerializes a document read result into the stable OfficeIMO transport shape.
Parameters
- result OfficeIMO.Reader.OfficeDocumentReadResult
- Read result to serialize.
- indented System.Boolean = false
- When true, writes indented JSON for diagnostics and fixtures.
public static IReadOnlyList<OfficeDocumentMaterializedAsset> WriteAssetsToDirectory(OfficeDocumentReadResult result, String directoryPath, OfficeDocumentAssetMaterializationOptions options = null, CancellationToken cancellationToken = null) #Returns:
IReadOnlyList<OfficeDocumentMaterializedAsset>Writes materializable asset payloads to directoryPath using each asset's deterministic filename.
Parameters
- result OfficeIMO.Reader.OfficeDocumentReadResult
- Read result that owns the assets.
- directoryPath System.String
- Destination directory.
- options OfficeIMO.Reader.OfficeDocumentAssetMaterializationOptions = null
- Materialization options.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.