TableRecognitionSettings

Settings for TableRecognition. 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 TableRecognitionSettings

Construction

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

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

Properties

row_collapse_coverage_divisor

@property
def row_collapse_coverage_divisor(self) -> int

@row_collapse_coverage_divisor.setter
def row_collapse_coverage_divisor(self, value: int) -> None

Coverage divisor for the row-collapse trigger: a whole-crop decode is a collapse candidate when decodedRows * divisor <= estimatedTextLines. Larger divisors fire less often. The shipped value is 3; the consumer clamps overrides to the 2..4 range the guard was measured on. The default (3) reproduces the shipped guard.

Type: int

Default: 3

row_collapse_guard_enabled

@property
def row_collapse_guard_enabled(self) -> bool

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

Enables the row-collapse guard on the table split-and-stitch rescue path. When enabled (the default), a whole-crop decode that covers far too few of the zone’s own text lines is treated as a collapse candidate, and the banded re-decode is attempted and gated by row coverage. Disabling it restores the pre-guard split behaviour exactly. The default (true) reproduces the shipped guard.

Type: bool

Default: true

target_size

@property
def target_size(self) -> int

@target_size.setter
def target_size(self, value: int) -> None

Target size for image preprocessing (height and width). Default is 448x448 as specified in the TableFormer model.

Type: int

Default: 448