API Reference
OcrRequest
One engine-neutral recognition request. Document formats map their source objects into this contract without making OCR providers depend on Reader, PDF, Word, Excel, PowerPoint, or another format package.
Inheritance
- Object
- OcrRequest
Usage
Explore 8 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.
Accepted by parameters 8
- Method AdaptiveOcrEngine.RecognizeAsync
- Method AdaptiveOcrEngine.RecognizeWithReviewAsync
- Constructor DelegateOcrEngine.DelegateOcrEngine
- Method DelegateOcrEngine.RecognizeAsync
- Method IOcrEngine.RecognizeAsync
- Method OcrEngineExecution.RecognizeAsync
- Method OcrEngineExecution.RecognizeAttachedAsync
- Method OcrEngineRunner.RecognizeAsync
Constructors
public OcrRequest() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public OcrOperation Operation { get; set; } #Requested operation. Existing callers and providers default to text recognition.
public Byte[] Payload { get; set; } #Validated raster payload supplied to the engine.
public String? FileName { get; set; } #Original or synthetic file name, used only as provider input metadata.
public String? SourceId { get; set; } #Stable caller-owned identifier for the source document or artifact.
public String? CandidateId { get; set; } #Stable caller-owned identifier for this recognition candidate.
public String? CandidateKind { get; set; } #Caller-defined candidate kind such as image, page, slide, or worksheet-image.
public Int32? PageNumber { get; set; } #One-based page or frame number within the source payload, when applicable.
public OcrRegion? Region { get; set; } #Source region represented by the payload, when the caller extracted only part of an artifact.
public OcrCoordinateUnit RegionCoordinateUnit { get; set; } #Coordinate unit used by OcrRequest.Region.
public String? Language { get; set; } #Requested language tag or provider-specific language expression, when configured.
public IReadOnlyDictionary<String, String> ProviderOptions { get; set; } #Provider-specific scalar options supplied by the host.