OcrSettings

public final class OcrSettings

Settings for Ocr. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document's settings, otherwise the SDK globally when set on SdkSettings.

Functions

Link copied to clipboard
public final String getDefaultLanguages()
Default OCR languages to use (comma-separated language codes).
Link copied to clipboard
public final boolean getEnableOrientationDetection()
Indicates whether the OCR engine detects and compensates page orientation (90°/180°/270°) during recognition.
Link copied to clipboard
public final boolean getEnablePreprocessing()
Indicates whether to enable image preprocessing before OCR.
Link copied to clipboard
public final boolean getEnableSkewDetection()
Indicates whether to enable automatic skew detection and correction.
Link copied to clipboard
public final boolean getEnableTableDetection()
Indicates whether to detect and extract tables from OCR output.
Link copied to clipboard
public final boolean getFavorAccuracy()
Indicates whether to favor accuracy over speed in OCR processing.
Link copied to clipboard
public final int getMaxLanguages()
Maximum number of languages to report from offline language detection.
Link copied to clipboard
public final int getMaxScripts()
Maximum number of writing scripts to recognize on a page during offline language detection (and the "auto" OCR path).
Link copied to clipboard
public final int getMaxThreads()
The maximum number of pages processed concurrently when a document-level OCR operation (such as making a document searchable) runs over multiple pages.
Link copied to clipboard
public final double getMinLanguageVoteFraction()
Consensus control for multi-language detection (only applies when is greater than 1).
Link copied to clipboard
public final int getMinLanguageVotes()
Consensus control for multi-language detection (only applies when is greater than 1).
Link copied to clipboard
public final double getMinScriptRatio()
Minimum share of a page (0.0 to 1.0) a secondary writing script must occupy before the page is also read with that script's model (only applies when is greater than 1).
Link copied to clipboard
public final void setDefaultLanguages(String value)
Default OCR languages to use (comma-separated language codes).
Link copied to clipboard
public final void setEnableOrientationDetection(boolean value)
Indicates whether the OCR engine detects and compensates page orientation (90°/180°/270°) during recognition.
Link copied to clipboard
public final void setEnablePreprocessing(boolean value)
Indicates whether to enable image preprocessing before OCR.
Link copied to clipboard
public final void setEnableSkewDetection(boolean value)
Indicates whether to enable automatic skew detection and correction.
Link copied to clipboard
public final void setEnableTableDetection(boolean value)
Indicates whether to detect and extract tables from OCR output.
Link copied to clipboard
public final void setFavorAccuracy(boolean value)
Indicates whether to favor accuracy over speed in OCR processing.
Link copied to clipboard
public final void setMaxLanguages(int value)
Maximum number of languages to report from offline language detection.
Link copied to clipboard
public final void setMaxScripts(int value)
Maximum number of writing scripts to recognize on a page during offline language detection (and the "auto" OCR path).
Link copied to clipboard
public final void setMaxThreads(int value)
The maximum number of pages processed concurrently when a document-level OCR operation (such as making a document searchable) runs over multiple pages.
Link copied to clipboard
public final void setMinLanguageVoteFraction(double value)
Consensus control for multi-language detection (only applies when is greater than 1).
Link copied to clipboard
public final void setMinLanguageVotes(int value)
Consensus control for multi-language detection (only applies when is greater than 1).
Link copied to clipboard
public final void setMinScriptRatio(double value)
Minimum share of a page (0.0 to 1.0) a secondary writing script must occupy before the page is also read with that script's model (only applies when is greater than 1).