API Reference
ProcessOcrEngineOptions
Configures the generic JSON file-protocol OCR process engine.
Inheritance
- Object
- ProcessOcrEngineOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Constructor ProcessOcrEngine.ProcessOcrEngine
Constructors
public ProcessOcrEngineOptions() #Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String FileName { get; set; } #Direct executable path or name. Required.
public IReadOnlyList<String> Arguments { get; set; } #Argument templates. Supported placeholders are {request}, {input}, {output}, {language}, {candidateId}, {sourceId}, and {pageNumber}.
public String Id { get; set; } #Stable engine identifier. Defaults to process; the untrimmed value must not exceed MaximumEngineIdCharacters characters.
public String WorkingDirectory { get; set; } #Optional working directory for the executable.
public IReadOnlyDictionary<String, String> EnvironmentVariables { get; set; } #Optional environment values applied to the child process.
public String TemporaryDirectory { get; set; } #Optional parent directory for isolated per-request temporary folders.
public TimeSpan Timeout { get; set; } #Maximum process duration. Defaults to two minutes.
public Int64 MaxOutputBytes { get; set; } #Maximum JSON response size. Defaults to 16 MiB.
public Int64 MaxInputBytes { get; set; } #Maximum input payload size accepted by direct engine calls. Defaults to 25 MiB.
public Int32 MaxProcessOutputCharacters { get; set; } #Maximum retained standard-output and standard-error characters.
public Boolean KeepTemporaryFiles { get; set; } #Whether isolated temporary files are retained after recognition.
public OcrEngineCapabilities Capabilities { get; set; } #Capabilities advertised by the external protocol implementation.