AiTextCorrectionSettings
Settings for AiTextCorrection. 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 AiTextCorrectionSettingsConstruction
AiTextCorrectionSettings is accessed through a Document instance for per-document overrides, or via SdkSettings for SDK-wide defaults.
# Per-document overridewith Document.open("input.pdf") as doc: settings = doc.settings.ai_text_correction_settings settings.some_field = new_value # mutate fields directly
# SDK-wide default (applies to all documents)SdkSettings.ai_text_correction_settings.some_field = new_valueSettings are configured by writing to fields on the returned object. The settings property itself cannot be reassigned — doc.settings.ai_text_correction_settings = other_settings is rejected.
Properties
enabled
@propertydef enabled(self) -> bool
@enabled.setterdef enabled(self, value: bool) -> NoneIndicates whether AI text correction is enabled. When disabled, the capacity passes through the document layout unchanged.
Type: bool
Default: true
mode
@propertydef mode(self) -> TextCorrectionMode
@mode.setterdef mode(self, value: TextCorrectionMode) -> NoneControls how differences between VLM and OCR text are resolved.
Type: TextCorrectionMode
Default: TextCorrectionMode.Auto