API Reference
Class
ProcessOcrEngine
Runs an external executable that implements the OfficeIMO OCR JSON file protocol.
Inheritance
- Object
- ProcessOcrEngine
Constructors
public ProcessOcrEngine(ProcessOcrEngineOptions options) #Creates a process-backed OCR engine from an immutable option snapshot.
Parameters
- options OfficeIMO.Ocr.Process.ProcessOcrEngineOptions
Methods
public async Task<OcrResult> RecognizeAsync(OcrRequest request, CancellationToken cancellationToken = default) #Returns:
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) #Returns:
BooleanInherited from Object
Parameters
- 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 OcrEngineCapabilities Capabilities { get; } #Stable capabilities exposed by this configured engine instance.