API Reference

Class

TesseractOcrEngine

Namespace OfficeIMO.Ocr.Tesseract
Assembly OfficeIMO.Ocr.Tesseract
Implements
IOcrEngine
Modifiers sealed

Optional cross-platform OCR engine backed by an installed Tesseract command-line executable.

Inheritance

  • Object
  • TesseractOcrEngine

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Constructors

public TesseractOcrEngine(TesseractOcrEngineOptions options = null) #

Creates a Tesseract engine from an immutable option snapshot.

Parameters

options OfficeIMO.Ocr.Tesseract.TesseractOcrEngineOptions = null optionalposition: 0

Methods

public static TesseractOcrEngine CreateDefault(TesseractOcrEngineOptions options = null) #
Returns: TesseractOcrEngine

Creates an engine using explicit, environment, PATH, and known-location runtime discovery.

Parameters

options OfficeIMO.Ocr.Tesseract.TesseractOcrEngineOptions = null optionalposition: 0
public async Task<IReadOnlyList<String>> GetLanguagesAsync(CancellationToken cancellationToken = null) #
Returns: Task<IReadOnlyList<String>>

Returns sorted language identifiers from tesseract --list-langs.

Parameters

cancellationToken System.Threading.CancellationToken = null optionalposition: 0
public async Task<String> GetVersionAsync(CancellationToken cancellationToken = null) #
Returns: Task<String>

Returns the first line from tesseract --version.

Parameters

cancellationToken System.Threading.CancellationToken = null optionalposition: 0
public virtual async Task<OcrResult> RecognizeAsync(OcrRequest request, CancellationToken cancellationToken = null) #
Returns: Task<OcrResult>

Parameters

request OfficeIMO.Ocr.OcrRequest requiredposition: 0
cancellationToken System.Threading.CancellationToken = null optionalposition: 1

Properties

public virtual String Id { get; } #
public String ExecutablePath { get; } #

Resolved executable path or command captured by this engine.

public String DefaultLanguage { get; } #

Default language expression captured by this engine.

public String TessdataDirectory { get; } #

Configured trained-data directory captured by this engine.

public virtual OcrEngineCapabilities Capabilities { get; } #