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

AiTextCorrectionSettings

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

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 AiTextCorrectionSettings

Construction

AiTextCorrectionSettings 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.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_value

Settings 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 

@property
def enabled(self) -> bool


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

Indicates whether AI text correction is enabled. When disabled, the capacity passes through the document layout unchanged.

Type: bool

Default: true

mode 

@property
def mode(self) -> TextCorrectionMode


@mode.setter
def mode(self, value: TextCorrectionMode) -> None

Controls how differences between VLM and OCR text are resolved.

Type: TextCorrectionMode

Default: TextCorrectionMode.Auto