Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

AdaptiveOcrEngine

OfficeIMO.Ocr

Namespace
OfficeIMO.Ocr
Assembly
OfficeIMO.Ocr
Source revision
ba882f6b0d07 with working tree changes
Implements
IOcrEngine
Modifiers
sealed

Opt-in, bounded retries of weak OCR evidence using caller-configured recognition variants.

Inheritance

  • object
  • AdaptiveOcrEngine

Remarks

Variants receive identical raster bytes, metadata, and coordinate frames. Configure segmentation or language in each provider; raster preparation remains in the format/scanning owner. Retries cannot silently approve text.

Constructors

public AdaptiveOcrEngine(string id, IReadOnlyList<OcrRecognitionAttempt> attempts, OcrReviewPolicy? reviewPolicy = null, TimeSpan? timeout = null, int maximumSpans = 100000, int maximumTextCharacters = 1000000, long maximumInputBytes = 26214400) #

Creates up to four ordered variants with a single total execution budget.

Parameters

id string required
Stable identifier for this configured policy.
attempts System.Collections.Generic.IReadOnlyList<OfficeIMO.Ocr.OcrRecognitionAttempt> required
First attempt is the baseline. The review policy controls whether later variants always run or run only after failed checks.
reviewPolicy OfficeIMO.Ocr.OcrReviewPolicy? = null optional
Measurable checks; defaults are starting settings, not calibrated accuracy claims.
timeout System.TimeSpan? = null optional
Total budget including every gate wait, result capture, and retry. Defaults to one minute.
maximumSpans int = 100000 optional
Maximum retained spans per attempt.
maximumTextCharacters int = 1000000 optional
Maximum text characters per attempt, including span text.
maximumInputBytes long = 26214400 optional
Maximum encoded raster bytes; each attempt receives an isolated copy.

Methods

public async Task<OcrResult> RecognizeAsync(OcrRequest request, CancellationToken cancellationToken = default) #

Recognizes text and optional detailed spans from one raster payload.

Parameters

request OfficeIMO.Ocr.OcrRequest required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OcrResult>
public async Task<AdaptiveOcrResult> RecognizeWithReviewAsync(OcrRequest request, CancellationToken cancellationToken = default) #

Recognizes text and returns content-free attempt, uncertainty, disagreement, and selection evidence.

Parameters

request OfficeIMO.Ocr.OcrRequest required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<AdaptiveOcrResult>

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.