API Reference
Cmdlet
Get-OfficeDocumentChunk
Reads supported Office, PDF, Markdown, RTF, HTML, CSV, JSON, XML, YAML, ZIP, EPUB, Visio, and text files into normalized OfficeIMO.Reader chunks.
Remarks
This is a thin adapter over OfficeDocumentReader. The OfficeIMO.Reader engine owns detection, extraction, hashing, and chunk shaping.
Examples
Read semantic chunks from an RTF document.
PS>
New-OfficeRtf -Path .\Report.rtf -Text 'Summary', 'Ready for review'
Get-OfficeDocumentChunk -Path .\Report.rtf | Select-Object Kind, Text
Creates a small RTF file and reads it back through the Reader adapter as normalized chunks.
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-OfficeDocumentChunk [-AllStoreItems] [-ExcelA1Range <String>] [-ExcelChunkRows <Int32>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-MaxChars <Int32>] [-MaxInputBytes <Int64>] [-MaxStoreItems <Int32>] [-MaxTableRows <Int32>] [-NoExcelHeaders] [-NoHashes] [-NoMarkdownHeadingChunks] [-OpenXmlMaxCharactersInPart <Int64>] -Path <String> [-Reader <OfficeDocumentReader>] [<CommonParameters>]Parameter set:
FileParameters
- AllStoreItems SwitchParameter
- Project every matching item from each email store.
- ExcelA1Range String
- Optional Excel A1 range to read.
- ExcelChunkRows Int32
- Excel rows per emitted worksheet chunk.
- ExcelSheetName String
- Optional Excel sheet name to read.
- ExcludePowerPointNotes SwitchParameter
- Exclude PowerPoint speaker notes.
- ExcludeWordFootnotes SwitchParameter
- Exclude Word footnotes.
- MaxChars Int32
- Maximum emitted chunk characters.
- MaxInputBytes Int64
- Maximum input size in bytes.
- MaxStoreItems Int32
- Maximum PST, OST, OLM, or EMLX items projected from each store. The default is 1,000.
- MaxTableRows Int32
- Maximum table rows per emitted table chunk.
- NoExcelHeaders SwitchParameter
- Treat the first Excel row as data instead of headers.
- NoHashes SwitchParameter
- Disable source and chunk hash computation.
- NoMarkdownHeadingChunks SwitchParameter
- Do not split Markdown by headings.
- OpenXmlMaxCharactersInPart Int64
- OpenXML maximum characters per part.
- Path String
- File path to read.
- Reader OfficeDocumentReader
- Optional immutable OfficeIMO reader with caller-configured handlers and processors.
Outputs
OfficeIMO.Reader.ReaderChunk
Get-OfficeDocumentChunk [-AllStoreItems] [-ExcelA1Range <String>] [-ExcelChunkRows <Int32>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-Extension <String[]>] -FolderPath <String> [-MaxChars <Int32>] [-MaxFiles <Int32>] [-MaxInputBytes <Int64>] [-MaxStoreItems <Int32>] [-MaxTableRows <Int32>] [-MaxTotalBytes <Int64>] [-NoExcelHeaders] [-NoHashes] [-NoMarkdownHeadingChunks] [-NoRecurse] [-OpenXmlMaxCharactersInPart <Int64>] [-Reader <OfficeDocumentReader>] [<CommonParameters>]Parameter set:
FolderParameters
- AllStoreItems SwitchParameter
- Project every matching item from each email store.
- ExcelA1Range String
- Optional Excel A1 range to read.
- ExcelChunkRows Int32
- Excel rows per emitted worksheet chunk.
- ExcelSheetName String
- Optional Excel sheet name to read.
- ExcludePowerPointNotes SwitchParameter
- Exclude PowerPoint speaker notes.
- ExcludeWordFootnotes SwitchParameter
- Exclude Word footnotes.
- Extension String[]
- Allowed folder extensions such as .docx, .xlsx, .pdf, or md.
- FolderPath String
- Folder path to read.
- MaxChars Int32
- Maximum emitted chunk characters.
- MaxFiles Int32
- Maximum number of folder files to read.
- MaxInputBytes Int64
- Maximum input size in bytes.
- MaxStoreItems Int32
- Maximum PST, OST, OLM, or EMLX items projected from each store. The default is 1,000.
- MaxTableRows Int32
- Maximum table rows per emitted table chunk.
- MaxTotalBytes Int64
- Maximum total folder bytes to read.
- NoExcelHeaders SwitchParameter
- Treat the first Excel row as data instead of headers.
- NoHashes SwitchParameter
- Disable source and chunk hash computation.
- NoMarkdownHeadingChunks SwitchParameter
- Do not split Markdown by headings.
- NoRecurse SwitchParameter
- Do not recurse into child folders when reading a folder.
- OpenXmlMaxCharactersInPart Int64
- OpenXML maximum characters per part.
- Reader OfficeDocumentReader
- Optional immutable OfficeIMO reader with caller-configured handlers and processors.
Outputs
OfficeIMO.Reader.ReaderChunk