DocumentSplitSettings

Settings for DocumentSplit. 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 DocumentSplitSettings

Construction

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

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

Properties

boundary_threshold

@property
def boundary_threshold(self) -> float

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

Calibrated per-page confidence, in [0,1], at or above which a page starts a new sub-document. The first page is always a boundary. Higher values yield fewer, larger segments (the model must be more certain to cut); lower values split more eagerly. Default 0.5.

Type: float

Default: 0.5f

include_page_confidences

@property
def include_page_confidences(self) -> bool

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

Diagnostic opt-in. When true, the split artifact additionally carries the calibrated boundary confidence for every page (pageConfidences), letting a caller re-threshold the stream offline without re-running the model. Default false so production artifacts stay lean.

Type: bool

Default: false

render_dpi

@property
def render_dpi(self) -> int

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

DPI used to render each page for the image tower. Default 200.

Type: int

Default: 200