PreprocessingSettings

Settings for Preprocessing. 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.

Tags: Vision, Advanced

from nutrient_sdk import PreprocessingSettings

Construction

# Per-document override
with Document.open("input.pdf") as doc:
    settings = doc.settings.preprocessing_settings
    settings.some_field = new_value          # mutate fields directly

# SDK-wide default (applies to all documents)
SdkSettings.preprocessing_settings.some_field = new_value

Settings are configured by writing to fields on the returned object. The settings property itself cannot be reassigned — doc.settings.preprocessing_settings = other_settings is rejected.

Properties

restoration_mode

@property
def restoration_mode(self) -> RestorationMode

@restoration_mode.setter
def restoration_mode(self, value: RestorationMode) -> None

Controls optional page-image restoration before vision inference. Keep this disabled unless the pipeline is processing a photographed document page that needs restoration. In particular, use Local only for badly taken document photos, not for regular scans, screenshots, born-digital PDFs, or already flat images.

Type: RestorationMode

Default: RestorationMode.Disabled