Cmdlet

Get-OfficeImageDocument

Module PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.Ocr.PdfSearchableOcrReview

Source

GetOfficeImageDocumentCommand.cs:22 Edit on GitHub

Recognizes an image as editable text, reading order and detected tables, with review evidence.

Syntax

Get-OfficeImageDocument [-Language <TesseractOcrLanguage[]>] [-MinimumConfidence <Double>] [-NoLanguageDownload] [-Options <TesseractOcrSessionOptions>] [-Path] <String> [-Provider <IOcrEngine>] [-RecognitionOptions <PdfOcrMergeOptions>] [-TessdataDirectory <String>] [-TesseractLanguageExpression <String>] [-TesseractPath <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Uses the original image resolution and the shared OfficeIMO layout engine. Animated and multi-page images are rejected.

Examples

Authored help example

Recognize a ledger once and export its reviewed table.

$image = Get-OfficeImageDocument -Path .\Ledger.png
$image | ConvertFrom-OfficeImage -OutputPath .\Ledger.xlsx -FirstRowIsHeader

Inspect $image.Ocr.Document.Tables and $image.Ocr.Pages before confirming the first row as headers.

Parameters

-Language TesseractOcrLanguage[] optional: Friendly OCR languages. Supply more than one value to recognize multilingual content.; Possible values: English, Polish, Arabic, ChineseSimplified, ChineseTraditional, Czech, Danish, Dutch, Finnish, French, German, Greek, Hebrew, Hindi, Hungarian, Italian, Japanese, Korean, Norwegian, Portuguese, Romanian, Russian, Slovak, Spanish, Swedish, Turkish, Ukrainian, Vietnamese
-MinimumConfidence Double optional: Minimum normalized confidence accepted into the editable document.
-NoLanguageDownload SwitchParameter optional: Do not download checksum-pinned curated language data when a requested language is missing.
-Options TesseractOcrSessionOptions optional: Advanced OfficeIMO OCR options. Convenience parameters override matching values.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: Path to a supported single-frame raster image.
-Provider IOcrEngine optional: Optional engine-neutral OCR provider. When omitted, uses the configured local Tesseract session.
-RecognitionOptions PdfOcrMergeOptions optional: Advanced layout, confidence, orientation, scan preparation and resource limits.
-TessdataDirectory String optional: Explicit directory containing Tesseract trained-data files.
-TesseractLanguageExpression String optional: Advanced raw Tesseract expression for caller-installed custom trained-data models.
-TesseractPath String optional: Explicit Tesseract executable path. By default OfficeIMO securely discovers an installed runtime.

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.