FinalizerSettings

Settings for Finalizer. 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 FinalizerSettings

Construction

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

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

Properties

enable_validation

@property
def enable_validation(self) -> bool

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

Indicates whether validation of the final document layout is enabled.

Type: bool

Default: true

minimum_document_confidence

@property
def minimum_document_confidence(self) -> float

@minimum_document_confidence.setter
def minimum_document_confidence(self, value: float) -> None

Minimum overall confidence threshold for the final document (0.0 - 1.0). Documents with average confidence below this threshold will trigger a validation warning.

Type: float

Default: 0.6f

recover_unclaimed_text

@property
def recover_unclaimed_text(self) -> bool

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

Keeps recognized text that no other stage claimed. A word belongs to a detected region, and each kind of region has a stage that turns it into content - paragraphs, table cells, key-value pairs. A region whose stage produced nothing, or which no stage handles at all, leaves its words with no route into the output, and they are silently missing from the exported document. When enabled (the default), those words are emitted as plain text lines in the region’s reading-order position. Words inside picture regions are excluded; they are governed by the picture text-extraction setting instead.

Type: bool

Default: true