API Reference

Class

PdfOcrMergeOptions

Namespace OfficeIMO.Pdf.Ocr
Assembly OfficeIMO.Pdf.Ocr
Modifiers sealed

Controls canonical parsing, OCR rendering, confidence filtering, and native-text overlap removal.

Inheritance

  • Object
  • PdfOcrMergeOptions

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

Accepted by parameters

Constructors

Methods

public PdfOcrMergeOptions Clone() #
Returns: PdfOcrMergeOptions

Creates an independent option snapshot.

Properties

public PdfReadOptions ReadOptions { get; set; } #

Canonical semantic-read settings, including page selection, layout, stage customization, and understanding budgets. OCR evidence is processed by this same read pipeline.

public String Language { get; set; } #

Requested language tag or provider-specific expression forwarded to the OCR engine.

public String SourceName { get; set; } #

Optional source path or logical name attached to OCR requests.

public String SourceId { get; set; } #

Optional stable source identifier attached to OCR requests.

public Boolean UseLineSpansWhenWordsUnavailable { get; set; } #

Uses line spans when the engine does not return word spans.

public Double ConfidenceWhenUnavailable { get; set; } #

Confidence used when neither a span nor the overall result reports one. Defaults to zero.

public IReadOnlyDictionary<String, String> ProviderOptions { get; set; } #

Provider-specific scalar options forwarded to the OCR engine.

public Double Dpi { get; set; } #

OCR render DPI.

public Double MinimumConfidence { get; set; } #

Minimum accepted provider confidence from 0 through 1.

public Double NativeTextOverlapThreshold { get; set; } #

Overlap ratio at which OCR words duplicating native text are removed.

public Int32 MaxPages { get; set; } #

Maximum pages sent to the provider.

public TimeSpan ProviderTimeout { get; set; } #

Maximum total duration for one provider call, including exclusive-engine wait time. Defaults to two minutes.

public Int64 MaxPixelsPerPage { get; set; } #

Maximum pixels rendered per page.

public Int32 MaxOcrSpansPerPage { get; set; } #

Maximum detailed spans inspected from the provider for one page.

public Int32 MaxOcrWordsPerPage { get; set; } #

Maximum OCR words accepted from the provider for one page.

public Int32 MaxOcrTextCharactersPerPage { get; set; } #

Maximum aggregate selected OCR span characters inspected for one page.

public Int32 MaxOcrHierarchyCharactersPerPage { get; set; } #

Maximum aggregate raw block, paragraph, and line identifier characters inspected for one page.

public Int32 MaxDiagnosticsPerPage { get; set; } #

Maximum provider diagnostics accepted for one page.

public Int32 MaxDiagnosticCharactersPerPage { get; set; } #

Maximum aggregate provider diagnostic characters accepted for one page.

public Int32 MaxProviderMetadataCharactersPerPage { get; set; } #

Maximum aggregate provider, model, and language metadata characters accepted for one page.

public Int32 MaxNativeTextBlocksPerPage { get; set; } #

Maximum native text blocks merged with OCR output for one page.

public Int64 MaxNativeTextOverlapComparisonsPerPage { get; set; } #

Maximum native-text overlap comparisons performed for one page.

public Int32 MaxMergedTextCharactersPerPage { get; set; } #

Maximum characters retained in one merged native/OCR text result.