API Reference
TesseractOcrEngine
Optional cross-platform OCR engine backed by an installed Tesseract command-line executable.
Inheritance
- Object
- TesseractOcrEngine
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Constructors
public TesseractOcrEngine(TesseractOcrEngineOptions? options = null) #Creates a Tesseract engine from an immutable option snapshot.
Parameters
- options OfficeIMO.Ocr.Tesseract.TesseractOcrEngineOptions? = null
Methods
public static TesseractOcrEngine CreateDefault(TesseractOcrEngineOptions? options = null) #TesseractOcrEngineCreates an engine using explicit, environment, PATH, and known-location runtime discovery.
Parameters
- options OfficeIMO.Ocr.Tesseract.TesseractOcrEngineOptions? = null
public async Task<IReadOnlyList<String>> GetLanguagesAsync(CancellationToken cancellationToken = default) #Task<IReadOnlyList<String>>Returns sorted language identifiers from tesseract --list-langs.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public async Task<String> GetVersionAsync(CancellationToken cancellationToken = default) #Task<String>Returns the first line from tesseract --version.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public async Task<OcrResult> RecognizeAsync(OcrRequest request, CancellationToken cancellationToken = default) #Task<OcrResult>Recognizes text and optional detailed spans from one raster payload.
Parameters
- request OfficeIMO.Ocr.OcrRequest
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String Id { get; } #Stable provider identifier used in diagnostics and provenance. The value must remain unchanged for the lifetime of this configured engine instance, and the untrimmed value must not exceed OcrEngineRunner.MaximumEngineIdCharacters characters.
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 OcrEngineCapabilities Capabilities { get; } #Stable capabilities exposed by this configured engine instance.