Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ReaderChunk

OfficeIMO.Reader

Namespace
OfficeIMO.Reader
Assembly
OfficeIMO.Reader.Core
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

A normalized extraction chunk produced by OfficeDocumentReader.

Inheritance

  • object
  • ReaderChunk

Usage

Explore 16 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 4

Constructors

public ReaderChunk() #

Properties

public string Id { get; set; } #

Stable, ASCII-only identifier.

public ReaderInputKind Kind { get; set; } #

The kind of input that produced this chunk.

public ReaderLocation Location { get; set; } #

Source location information for citations and debugging.

public string? SourceId { get; set; } #

Stable identifier for the source document. For file-based reads this is deterministic for a given normalized path.

public string? SourceHash { get; set; } #

Optional content hash for the source document (for incremental upserts).

public string? ChunkHash { get; set; } #

Optional content hash for this chunk (for incremental upserts).

public DateTime? SourceLastWriteUtc { get; set; } #

Optional source last-write timestamp (UTC) when available.

public long? SourceLengthBytes { get; set; } #

Optional source length in bytes when available.

public int? TokenEstimate { get; set; } #

Estimated token count (best-effort heuristic) for prompt budgeting.

public string Text { get; set; } #

Plain text representation of the chunk.

public string? Markdown { get; set; } #

Optional Markdown representation of the chunk.

public IReadOnlyList<ReaderTable>? Tables { get; set; } #

Optional structured tables extracted from this chunk.

public IReadOnlyList<ReaderVisual>? Visuals { get; set; } #

Optional structured visual fence metadata extracted from this chunk.

public IReadOnlyList<ReaderFormField>? FormFields { get; set; } #

Optional structured form fields extracted from this chunk.

public IReadOnlyList<ReaderActionSummary>? Actions { get; set; } #

Optional passive action summaries extracted from this chunk.

public ReaderChunkDiagnostics? Diagnostics { get; set; } #

Optional source-specific diagnostics and structural counters for this chunk.

public IReadOnlyList<string>? Warnings { get; set; } #

Optional warnings about truncation or unsupported content.