API Reference
OfficeDocumentOcrExecutionOptions
Controls bounded execution of an optional OCR engine over a document read result.
Inheritance
- Object
- OfficeDocumentOcrExecutionOptions
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
- Method OfficeDocumentOcrExecutionExtensions.ApplyOcrAsync
- Constructor OfficeDocumentOcrProcessor.OfficeDocumentOcrProcessor
- Extension method OfficeDocumentReadResult.ApplyOcrAsync
Constructors
public OfficeDocumentOcrExecutionOptions() #Methods
public OfficeDocumentOcrExecutionOptions Clone() #OfficeDocumentOcrExecutionOptionsCreates an independent execution configuration snapshot.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Language { get; set; } #Language or provider-specific language expression requested for every candidate.
public Int32 MaxCandidates { get; set; } #Maximum candidates considered in one execution. Defaults to 100.
public Int64 MaxInputBytesPerCandidate { get; set; } #Maximum payload size passed to the engine for one candidate. Defaults to 25 MiB.
public Int64 MaxTotalInputBytes { get; set; } #Maximum combined payload size passed to the engine. Defaults to 100 MiB.
public Int32 MaxDegreeOfParallelism { get; set; } #Maximum concurrent engine calls. Defaults to 1 and is forced to 1 for engines that do not advertise concurrency.
public TimeSpan CandidateTimeout { get; set; } #Maximum duration allowed for one engine call. Defaults to two minutes.
public Int32 MaxRecognizedCharactersPerCandidate { get; set; } #Maximum recognized text characters accepted from one engine response. Defaults to 1,000,000.
public Int32 MaxSpansPerCandidate { get; set; } #Maximum detailed spans accepted from one engine response. Defaults to 100,000.
public Boolean ContinueOnError { get; set; } #Whether one provider failure should become a diagnostic while remaining candidates continue.
public Boolean RequirePayloadHashMatch { get; set; } #Whether a declared asset payload hash must match before bytes are passed to an engine.
public IReadOnlyDictionary<String, String> ProviderOptions { get; set; } #Provider-specific scalar options copied into every engine request.
public OfficeDocumentOcrEnrichmentOptions EnrichmentOptions { get; set; } #Controls how recognized text is merged into the shared read result.