HandwritingSettings

Settings for Handwriting. 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 HandwritingSettings

Construction

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

# SDK-wide default (applies to all documents)
SdkSettings.handwriting_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.handwriting_settings = other_settings is rejected.

Properties

enable_handwriting_ocr

@property
def enable_handwriting_ocr(self) -> bool

@enable_handwriting_ocr.setter
def enable_handwriting_ocr(self, value: bool) -> None

Controls whether local handwriting OCR models run during vision processing. When disabled, handwriting text can still come from VLM augmentation, but the local handwriting classifier and word extraction models are skipped.

Type: bool

Default: false

word_refining_method

@property
def word_refining_method(self) -> WordRefiningMethod

@word_refining_method.setter
def word_refining_method(self, value: WordRefiningMethod) -> None

Controls the method used to refine detected handwritten words when AI-augmented text is available for the zone.

Type: WordRefiningMethod

Default: WordRefiningMethod.Heuristic