API Reference
OfficeDocumentOcrExecutionOptions
Controls bounded execution of an optional OCR engine over a document read result.
Inheritance
- Object
- OfficeDocumentOcrExecutionOptions
Usage
Explore 4 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.
Returned or exposed by 1
Accepted by parameters 3
Constructors
public OfficeDocumentOcrExecutionOptions() #Methods
public OfficeDocumentOcrExecutionOptions Clone() #OfficeDocumentOcrExecutionOptionsCreates an independent execution configuration snapshot.
Inherited Methods
public virtual 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 TimeSpan TotalTimeout { get; set; } #Shared deadline for admitting and waiting for engine calls, including nested documents. Defaults to five minutes. Local normalization and projection can finish after this deadline.
public Int32 MaxDocuments { get; set; } #Maximum documents visited by ApplyOcrTreeAsync, including the root. Defaults to 100.
public Int32 MaxNestedDepth { get; set; } #Maximum nested depth visited by ApplyOcrTreeAsync; the root has depth zero. Values from zero through 64 are accepted; defaults to eight.
public Int32 MaxTotalRecognizedCharacters { get; set; } #Maximum recognized text characters retained across the entire execution. Defaults to 4 Mi characters.
public Int32 MaxTotalSpans { get; set; } #Maximum detailed spans retained across the entire execution. Defaults to 100,000.
public Int32 MaxTotalSpanCharacters { get; set; } #Maximum span text and metadata characters retained across the entire execution. Defaults to 4 Mi characters.
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 Int32 MaxSpanCharactersPerCandidate { get; set; } #Maximum aggregate characters retained across span text and span metadata. Defaults to 4 Mi characters.
public Int32 MaxResultMetadataCharactersPerCandidate { get; set; } #Maximum aggregate characters retained in result provider, model, and language metadata. Defaults to 16 Ki characters.
public Int32 MaxProviderDiagnosticsPerCandidate { get; set; } #Maximum provider diagnostics retained from one engine response. Defaults to 1,000.
public Int32 MaxProviderDiagnosticCharactersPerCandidate { get; set; } #Maximum aggregate provider diagnostic code, message, and source characters. Defaults to 1 Mi characters.
public Int32 MaxProviderDiagnosticAttributesPerCandidate { get; set; } #Maximum aggregate provider diagnostic attributes retained per candidate. Defaults to 10,000.
public Int32 MaxProviderDiagnosticAttributeCharactersPerCandidate { get; set; } #Maximum aggregate provider diagnostic attribute key and value characters. Defaults to 1 Mi characters.
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.