Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 609 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Get-OfficeDocumentStructured

Module PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.Reader.OfficeDocumentStructuredExtractionResult
Source
GetOfficeDocumentStructuredCommand.cs:16 Edit on GitHub

Extracts a bounded schema-friendly view of a supported document.

Syntax

Get-OfficeDocumentStructured [-ExtractionOptions <OfficeDocumentStructuredExtractionOptions>] [-Path] <String> [-Reader <OfficeDocumentReader>] [-ReaderOptions <ReaderOptions>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Reader, Document Extraction, and OCR Guide

    Detect formats and extract normalized documents, chunks, hierarchy, tables, visuals, assets, OCR text, and ingest results. Includes examples and cmdlet links.

Examples

Authored help example

Extract sections, tables, forms, and scalar records.

$result = Get-OfficeDocumentStructured -Path .\report.docx; $result.Records | Group-Object Category

Returns deterministic structured records and source diagnostics without format-specific parsing.

Parameters

-ExtractionOptions OfficeDocumentStructuredExtractionOptions optional
Optional structured extraction categories and limits.
-Path String requiredposition: 0pipeline: True (ByValue)
Path to read.
-Reader OfficeDocumentReader optional
Optional immutable OfficeIMO reader with caller-configured handlers and processors.
-ReaderOptions ReaderOptions optional
Optional source-reading limits and format behavior.

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.