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

WordsDetectionSettings

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

Settings for WordsDetection. 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: Advanced, Vision

from nutrient_sdk import WordsDetectionSettings

Construction

WordsDetectionSettings 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.words_detection_settings
    settings.some_field = new_value          # mutate fields directly


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

Properties

confidence_threshold 

@property
def confidence_threshold(self) -> float


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

Detection confidence threshold (0.0 to 1.0). Detections with confidence below this threshold will be filtered out.

Type: float

Default: 0.5f