This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/python/settings/handwriting-settings.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. HandwritingSettings

HandwritingSettings

Markdown version of this page, suitable for AI agents and automation

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

from nutrient_sdk import HandwritingSettings

Construction

HandwritingSettings is accessed through a Document instance for per-document overrides, or via SdkSettings for SDK-wide defaults.

# 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

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