API Reference
ReaderChunkHierarchyResult
Bounded token-aware chunks plus their deterministic hierarchy and evidence.
Inheritance
- Object
- ReaderChunkHierarchyResult
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 DocumentReader.ChunkDocument
- Method DocumentReader.ReadHierarchical
- Method DocumentReader.ReadHierarchical
- Method DocumentReader.ReadHierarchicalAsync
- Method DocumentReader.ReadHierarchicalAsync
- Method OfficeDocumentReader.ChunkDocument
- Method OfficeDocumentReader.ReadHierarchical
- Method OfficeDocumentReader.ReadHierarchical
- Method OfficeDocumentReader.ReadHierarchicalAsync
- Method OfficeDocumentReader.ReadHierarchicalAsync
- Method ReaderHierarchicalChunker.Chunk
Accepted by parameters
- Method ReaderChunkHierarchyJson.Serialize
- Method ReaderChunkHierarchyJson.ToJson
- Extension method ReaderChunkHierarchyResult.ToJson
Constructors
public ReaderChunkHierarchyResult() #Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String SchemaId { get; set; } #Hierarchy schema identifier.
public Int32 SchemaVersion { get; set; } #Hierarchy schema version.
public OfficeDocumentSource Source { get; set; } #Source document metadata.
public String TokenCounterId { get; set; } #Token counter identifier.
public String RootNodeId { get; set; } #Document root node identifier.
public Int64 SourceTokenCount { get; set; } #Original source tokens before overlap and hierarchy context.
public Int64 OutputTokenCount { get; set; } #Total tokens emitted across output chunks.
public Int64 OverlapTokenCount { get; set; } #Total repeated overlap tokens across output chunks.
public Int64 ContextTokenCount { get; set; } #Total hierarchy-context tokens added to output chunks.
public IReadOnlyList<ReaderChunk> Chunks { get; set; } #Embedding-ready leaf chunks in source order.
public IReadOnlyList<ReaderChunkSegment> Segments { get; set; } #Source span and token evidence aligned to Chunks.
public IReadOnlyList<ReaderChunkHierarchyNode> Nodes { get; set; } #Flattened hierarchy nodes with explicit parent/child ids.
public IReadOnlyList<OfficeDocumentDiagnostic> Diagnostics { get; set; } #Limit and content diagnostics produced during chunking.
Extension Methods
public static String ToJson(ReaderChunkHierarchyResult result, Boolean indented = false) #StringSerializes a current hierarchy result.
Parameters
- result OfficeIMO.Reader.ReaderChunkHierarchyResult
- indented System.Boolean = false