API Reference

Class

ProcessOcrRequest

Namespace OfficeIMO.Ocr.Process
Assembly OfficeIMO.Ocr.Process
Modifiers sealed

Portable request file written for an external OCR process.

Inheritance

  • Object
  • ProcessOcrRequest

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

Properties

public String SchemaId { get; set; } #

Protocol schema identifier.

public Int32 SchemaVersion { get; set; } #

Protocol schema version.

public String CandidateId { get; set; } #

Caller-owned recognition candidate identifier.

public String CandidateKind { get; set; } #

Caller-defined candidate kind.

public String MediaType { get; set; } #

Input media type.

public String FileName { get; set; } #

Original or synthetic file name.

public String SourceId { get; set; } #

Stable source artifact identifier.

public String SourceName { get; set; } #

Source path or logical name.

public Nullable<Int32> PageNumber { get; set; } #

One-based source page or frame number.

public Nullable<Int32> PixelWidth { get; set; } #

Raster width in pixels.

public Nullable<Int32> PixelHeight { get; set; } #

Raster height in pixels.

public String InputPath { get; set; } #

Absolute path to the materialized input payload.

public String OutputPath { get; set; } #

Absolute path where the process must write an OcrResult response.

public String Language { get; set; } #

Requested language expression.

public OcrRegion Region { get; set; } #

Source region represented by the payload.

public OcrCoordinateUnit RegionCoordinateUnit { get; set; } #

Coordinate unit used by Region.

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

Provider-specific scalar options.