API Reference
Cmdlet
Get-OfficeDocumentIngest
Reads a folder into an OfficeIMO.Reader ingestion summary.
Remarks
Reads a folder into an OfficeIMO.Reader ingestion summary.
Examples
Ingest a report folder.
PS>
$ingest = Get-OfficeDocumentIngest -FolderPath .\Reports -Extension docx,pdf,rtf -MaxFiles 50
$ingest.Files | Select-Object Path, Status, ChunkCount
Reads supported files from a folder and returns the ingestion summary with per-file status and chunk counts.
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-OfficeDocumentIngest [-ExcelA1Range <String>] [-ExcelChunkRows <Nullable`1>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-Extension <String[]>] -FolderPath <String> [-MaxChars <Nullable`1>] [-MaxFiles <Nullable`1>] [-MaxInputBytes <Nullable`1>] [-MaxTableRows <Nullable`1>] [-MaxTotalBytes <Nullable`1>] [-NoChunks] [-NoExcelHeaders] [-NoHashes] [-NoMarkdownHeadingChunks] [-NoRecurse] [-OpenXmlMaxCharactersInPart <Nullable`1>] [-Reader <OfficeDocumentReader>] [<CommonParameters>]Parameter set:
All Parameter SetsParameters
- ExcelA1Range String
- Optional Excel A1 range to read.
- ExcelChunkRows Nullable`1
- 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, .html, or json.
- FolderPath String
- Folder path to ingest.
- MaxChars Nullable`1
- Maximum emitted chunk characters.
- MaxFiles Nullable`1
- Maximum number of folder files to read.
- MaxInputBytes Nullable`1
- Maximum input size in bytes.
- MaxTableRows Nullable`1
- Maximum table rows per emitted table chunk.
- MaxTotalBytes Nullable`1
- Maximum total folder bytes to read.
- NoChunks SwitchParameter
- Do not materialize chunks in the returned ingestion result.
- 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.
- OpenXmlMaxCharactersInPart Nullable`1
- OpenXML maximum characters per part.
- Reader OfficeDocumentReader
Outputs
OfficeIMO.Reader.ReaderIngestResult