API Reference
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 OfficeDocumentProcessingResult.Document
- Method OfficeDocumentProcessorBase.Process
- Method OfficeDocumentReader.ReadDocument
- Method OfficeDocumentReader.ReadDocument
- Method OfficeDocumentReader.ReadDocument
- Method OfficeDocumentReader.ReadDocumentAsync
- Method OfficeDocumentReader.ReadDocumentAsync
- Method OfficeDocumentReader.ReadDocumentAsync
- Method OfficeDocumentReader.ReadDocumentsAsync
- Method OfficeDocumentReadResultJson.Deserialize
- Method OfficeDocumentTableNormalizationProcessor.Process
- Property ReaderDocumentReadOutcome.Document
- 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 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 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.BuildAssetDataUriMap
- Extension method OfficeDocumentReadResult.EnumerateBlocks
- Extension method OfficeDocumentReadResult.EnumerateContent
- Extension method OfficeDocumentReadResult.EnumerateTables
- Extension method OfficeDocumentReadResult.GetPageMarkdown
- Extension method OfficeDocumentReadResult.GetPageProvenance
- Extension method OfficeDocumentReadResult.GetTotalPageCount
- Extension method OfficeDocumentReadResult.Locate
- Extension method OfficeDocumentReadResult.Locate
- Extension method OfficeDocumentReadResult.Search
- Extension method OfficeDocumentReadResult.StreamAssets
- Extension method OfficeDocumentReadResult.ToJson
- Extension method OfficeDocumentReadResult.ToPageMarkedMarkdown
- Extension method OfficeDocumentReadResult.WriteAssetsToDirectory
- Method OfficeDocumentReadResultExtensions.EnumerateBlocks
- Method OfficeDocumentReadResultExtensions.EnumerateContent
- Method OfficeDocumentReadResultExtensions.EnumerateTables
- Method OfficeDocumentReadResultExtensions.GetPageMarkdown
- Method OfficeDocumentReadResultExtensions.GetPageProvenance
- Method OfficeDocumentReadResultExtensions.GetTotalPageCount
- Method OfficeDocumentReadResultExtensions.Locate
- Method OfficeDocumentReadResultExtensions.Locate
- Method OfficeDocumentReadResultExtensions.Search
- Method OfficeDocumentReadResultExtensions.ToPageMarkedMarkdown
- 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) #BooleanParameters
- 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 IReadOnlyDictionary<String, String> BuildAssetDataUriMap(OfficeDocumentReadResult result, OfficeDocumentAssetDataUriOptions options = null) #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 IEnumerable<OfficeDocumentBlock> EnumerateBlocks(OfficeDocumentReadResult document) #IEnumerable<OfficeDocumentBlock>Enumerates document-level and page-level blocks in canonical source order, retaining each stable ID or anchor once. Blocks without either identity are deduplicated only by object reference, preserving unlabelled repeated text. Missing locations inherit their page context by reference or stable identity without changing the source. Results may refer to source objects or location projections; they are not immutable snapshots.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IEnumerable<OfficeDocumentContentItem> EnumerateContent(OfficeDocumentReadResult document) #IEnumerable<OfficeDocumentContentItem>Enumerates blocks and tables together in canonical source order. Chunks supply text only when no blocks contain text. Tables inherit a matching source block's position through their stable anchor. Table rows remain part of their table. Unpositioned content retains its encounter order after positioned content in the same container. Results reference source payloads or location projections and are not immutable snapshots.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IEnumerable<ReaderTable> EnumerateTables(OfficeDocumentReadResult document) #IEnumerable<ReaderTable>Enumerates tables from document, page and chunk projections using the Reader's canonical duplicate handling. Page-only tables inherit missing location information from their page. Results may refer to source model objects.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IReadOnlyList<OfficeDocumentPageMarkdown> GetPageMarkdown(OfficeDocumentReadResult document, OfficeDocumentPageMarkdownOptions options = null) #IReadOnlyList<OfficeDocumentPageMarkdown>Projects every page-like container into a separate Markdown value suitable for citations and RAG.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- options OfficeIMO.Reader.OfficeDocumentPageMarkdownOptions = null
public static OfficeDocumentPageProvenance GetPageProvenance(OfficeDocumentReadResult document) #OfficeDocumentPageProvenanceReturns the page provenance advertised by the producing adapter.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static Int32 GetTotalPageCount(OfficeDocumentReadResult document) #Int32Returns the best available total physical page count for this read result.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IReadOnlyList<OfficeDocumentPageLocation> Locate(OfficeDocumentReadResult document, OfficeDocumentBlock block) #IReadOnlyList<OfficeDocumentPageLocation>Locates a normalized block in every page-like container that references it.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- block OfficeIMO.Reader.OfficeDocumentBlock
public static IReadOnlyList<OfficeDocumentPageLocation> Locate(OfficeDocumentReadResult document, String blockId) #IReadOnlyList<OfficeDocumentPageLocation>Locates a normalized block by its stable identifier.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- blockId System.String
public static OfficeDocumentSearchResult Search(OfficeDocumentReadResult document, String query, OfficeDocumentSearchOptions options = null) #OfficeDocumentSearchResultSearches normalized document blocks and attaches page-like locations to every occurrence.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
- query System.String
- options OfficeIMO.Reader.OfficeDocumentSearchOptions = null
public static IReadOnlyList<OfficeDocumentMaterializedAsset> StreamAssets(OfficeDocumentReadResult result, Action<OfficeDocumentAsset, Stream> writeAsset, OfficeDocumentAssetMaterializationOptions options = null, CancellationToken cancellationToken = null) #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) #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 String ToPageMarkedMarkdown(OfficeDocumentReadResult document) #StringProjects all page-like containers into one Markdown string separated by portable page markers.
Parameters
- document OfficeIMO.Reader.OfficeDocumentReadResult
public static IReadOnlyList<OfficeDocumentMaterializedAsset> WriteAssetsToDirectory(OfficeDocumentReadResult result, String directoryPath, OfficeDocumentAssetMaterializationOptions options = null, CancellationToken cancellationToken = null) #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.