Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OcrEngineExecution

Namespace OfficeIMO.Ocr
Assembly OfficeIMO.Ocr
Source revision dce3df7a1b5d with working tree changes
Modifiers sealed

A validated, immutable identity and capability snapshot for one configured OCR engine instance.

Inheritance

  • Object
  • OcrEngineExecution

Remarks

Create one execution for a logical document operation and reuse it for every candidate. This prevents mutable provider properties from changing provenance or concurrency behavior partway through the operation.

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

Methods

RecognizeAsync 2 overloads
public Task<OcrResult> RecognizeAsync(OcrRequest request, TimeSpan timeout, CancellationToken cancellationToken = default) #
Returns: Task<OcrResult>

Recognizes one raster payload under the shared timeout and concurrency policy.

Parameters

request OfficeIMO.Ocr.OcrRequest requiredposition: 0
timeout System.TimeSpan requiredposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public Task<OcrResult> RecognizeAsync(OcrRequest request, TimeSpan timeout, OcrResultCaptureLimits captureLimits, CancellationToken cancellationToken) #
Returns: Task<OcrResult>

Recognizes a raster payload while bounding the owned result snapshot.

Parameters

request OfficeIMO.Ocr.OcrRequest requiredposition: 0
timeout System.TimeSpan requiredposition: 1
captureLimits OfficeIMO.Ocr.OcrResultCaptureLimits requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
public Task<OcrResult> RecognizeAttachedAsync(OcrRequest request, TimeSpan timeout, OcrResultCaptureLimits captureLimits, CancellationToken cancellationToken = default) #
Returns: Task<OcrResult>

Recognizes a bounded payload while keeping the caller attached to provider cleanup.

Parameters

request OfficeIMO.Ocr.OcrRequest requiredposition: 0
timeout System.TimeSpan requiredposition: 1
captureLimits OfficeIMO.Ocr.OcrResultCaptureLimits requiredposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3

Properties

public String Id { get; } #

Validated provider identifier captured when this execution was created.

public OcrEngineCapabilities Capabilities { get; } #

Independent copy of the capabilities captured when this execution was created.