Get-OfficeDocumentHierarchy

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Reader.ReaderChunkHierarchyResult

Source

Sources/PSWriteOffice/Cmdlets/Reader/GetOfficeDocumentHierarchyCommand.cs:14 Edit on GitHub

Creates bounded token-aware chunks and a deterministic document hierarchy.

Remarks

Creates bounded token-aware chunks and a deterministic document hierarchy.

Examples

Authored help example

Create embedding-ready chunks with heading context.

PS>


$options = [OfficeIMO.Reader.ReaderHierarchicalChunkingOptions]::new(); $options.MaxTokens = 500; $result = Get-OfficeDocumentHierarchy -Path .\handbook.pdf -ChunkingOptions $options

Returns chunks, token evidence, overlap counts, and flattened parent/child nodes.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-OfficeDocumentHierarchy [-ChunkingOptions <ReaderHierarchicalChunkingOptions>] -Path <String> [-Reader <OfficeDocumentReader>] [-ReaderOptions <ReaderOptions>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

ChunkingOptions ReaderHierarchicalChunkingOptions optionalposition: namedpipeline: False: Optional token budget, overlap, hierarchy, and token-counter settings.
Path String requiredposition: 0pipeline: True (ByValue): Path to read.
Reader OfficeDocumentReader optionalposition: namedpipeline: False
ReaderOptions ReaderOptions optionalposition: namedpipeline: False: Optional source-reading limits and format behavior.

Outputs

OfficeIMO.Reader.ReaderChunkHierarchyResult