Cmdlet

Get-OfficeDocumentIngest

Module: PSWriteOffice
Inputs: System.String
Outputs: OfficeIMO.Reader.ReaderIngestResult
Source: GetOfficeDocumentIngestCommand.cs:17 Edit on GitHub

Reads a folder into an OfficeIMO.Reader ingestion summary.

Syntax

Get-OfficeDocumentIngest
[-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>]
[-NoChunks]
[-NoExcelHeaders]
[-NoHashes]
[-NoMarkdownHeadingChunks]
[-NoRecurse]
[-OpenXmlMaxCharactersInPart <Int64>]
[-Reader <OfficeDocumentReader>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Ingest a report folder.

$ingest = Get-OfficeDocumentIngest -FolderPath .\Reports -Extension docx,pdf,rtf -MaxFiles 50
$ingest.Files | Select-Object Path, Parsed, ChunksProduced

Reads supported files from a folder and returns the ingestion summary with per-file status and chunk counts.

Parameters

-AllStoreItems SwitchParameter optional: Project every matching item from each email store.
-ExcelA1Range String optional: Optional Excel A1 range to read.
-ExcelChunkRows Int32 optional: Excel rows per emitted worksheet chunk.
-ExcelSheetName String optional: Optional Excel sheet name to read.
-ExcludePowerPointNotes SwitchParameter optional: Exclude PowerPoint speaker notes.
-ExcludeWordFootnotes SwitchParameter optional: Exclude Word footnotes.
-Extension String[] optionalaliases: Extensions: Allowed folder extensions such as .docx, .xlsx, .pdf, .html, or json.
-FolderPath String requiredposition: 0pipeline: True (ByValue): Folder path to ingest.
-MaxChars Int32 optional: Maximum emitted chunk characters.
-MaxFiles Int32 optional: Maximum number of folder files to read.
-MaxInputBytes Int64 optional: Maximum input size in bytes.
-MaxStoreItems Int32 optional: Maximum PST, OST, OLM, or EMLX items projected from each store. The default is 1,000.
-MaxTableRows Int32 optional: Maximum table rows per emitted table chunk.
-MaxTotalBytes Int64 optional: Maximum total folder bytes to read.
-NoChunks SwitchParameter optional: Do not materialize chunks in the returned ingestion result.
-NoExcelHeaders SwitchParameter optional: Treat the first Excel row as data instead of headers.
-NoHashes SwitchParameter optional: Disable source and chunk hash computation.
-NoMarkdownHeadingChunks SwitchParameter optional: Do not split Markdown by headings.
-NoRecurse SwitchParameter optional: Do not recurse into child folders.
-OpenXmlMaxCharactersInPart Int64 optional: OpenXML maximum characters per part.
-Reader OfficeDocumentReader optional: Optional immutable OfficeIMO reader with caller-configured handlers and processors.

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.