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

SdkSettings

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

Manages configuration settings for the Nutrient SDK. Provides functionality to load, export, and access various SDK settings through a type-safe registry system. This is a singleton class - use the static methods to access SDK settings.

Tags: Document

from nutrient_sdk import SdkSettings

Construction 

SdkSettings()

Creates a new SdkSettings instance with default settings.

Class Methods

export 

@classmethod
def export(cls, path: str) -> None

Static method to export the current SDK settings to a JSON file.

Parameters:

NameTypeDescription
pathstrThe file path where the JSON settings will be saved.

load 

@classmethod
def load(cls, path: str) -> None

Static method to load SDK settings from a JSON file.

Parameters:

NameTypeDescription
pathstrThe file path to the JSON settings file.

Methods

export_instance 

def export_instance(self, path: str) -> None

Exports the current SDK settings to a JSON file.

Parameters:

NameTypeDescription
pathstrThe file path where the JSON settings will be saved.

load_instance 

def load_instance(self, path: str) -> None

Loads SDK settings from a JSON file.

Parameters:

NameTypeDescription
pathstrThe file path to the JSON settings file.

Properties

ai_augmenter_settings 

@classproperty
def ai_augmenter_settings(cls) -> AiAugmenterSettings

Gets the settings for aiaugmenter.

Type: AiAugmenterSettings

Read-only property.

ai_processing_settings 

@classproperty
def ai_processing_settings(cls) -> AiProcessingSettings

Gets the settings for aiprocessing.

Type: AiProcessingSettings

Read-only property.

cad_settings 

@classproperty
def cad_settings(cls) -> CadSettings

Gets the settings for CAD.

Type: CadSettings

Read-only property.

claude_api_settings 

@classproperty
def claude_api_settings(cls) -> ClaudeApiSettings

Gets the settings for claudeapi.

Type: ClaudeApiSettings

Read-only property.

content_extraction_settings 

@classproperty
def content_extraction_settings(cls) -> ContentExtractionSettings

Gets the settings for contentextraction.

Type: ContentExtractionSettings

Read-only property.

conversion_settings 

@classproperty
def conversion_settings(cls) -> ConversionSettings

Gets the settings for conversion.

Type: ConversionSettings

Read-only property.

custom_vlm_api_settings 

@classproperty
def custom_vlm_api_settings(cls) -> CustomVlmApiSettings

Gets the settings for customvlmapi.

Type: CustomVlmApiSettings

Read-only property.

deskew_settings 

@classproperty
def deskew_settings(cls) -> DeskewSettings

Gets the settings for deskew.

Type: DeskewSettings

Read-only property.

document_layout_json_export_settings 

@classproperty
def document_layout_json_export_settings(cls) -> DocumentLayoutJsonExportSettings

Gets the settings for documentlayoutjsonexport.

Type: DocumentLayoutJsonExportSettings

Read-only property.

email_settings 

@classproperty
def email_settings(cls) -> EmailSettings

Gets the settings for email.

Type: EmailSettings

Read-only property.

finalizer_settings 

@classproperty
def finalizer_settings(cls) -> FinalizerSettings

Gets the settings for finalizer.

Type: FinalizerSettings

Read-only property.

form_labeling_settings 

@classproperty
def form_labeling_settings(cls) -> FormLabelingSettings

Gets the settings for formlabeling.

Type: FormLabelingSettings

Read-only property.

form_recognition_settings 

@classproperty
def form_recognition_settings(cls) -> FormRecognitionSettings

Gets the settings for formrecognition.

Type: FormRecognitionSettings

Read-only property.

handwriting_settings 

@classproperty
def handwriting_settings(cls) -> HandwritingSettings

Gets the settings for handwriting.

Type: HandwritingSettings

Read-only property.

html_settings 

@classproperty
def html_settings(cls) -> HtmlSettings

Gets the settings for HTML.

Type: HtmlSettings

Read-only property.

image_settings 

@classproperty
def image_settings(cls) -> ImageSettings

Gets the settings for image.

Type: ImageSettings

Read-only property.

inference_layout_settings 

@classproperty
def inference_layout_settings(cls) -> InferenceLayoutSettings

Gets the settings for inferencelayout.

Type: InferenceLayoutSettings

Read-only property.

instant_json_settings 

@classproperty
def instant_json_settings(cls) -> InstantJsonSettings

Gets the settings for instantjson.

Type: InstantJsonSettings

Read-only property.

jbig2_settings 

@classproperty
def jbig2_settings(cls) -> Jbig2Settings

Gets the settings for jbig2.

Type: Jbig2Settings

Read-only property.

jpeg_settings 

@classproperty
def jpeg_settings(cls) -> JpegSettings

Gets the settings for jpeg.

Type: JpegSettings

Read-only property.

markdown_settings 

@classproperty
def markdown_settings(cls) -> MarkdownSettings

Gets the settings for markdown.

Type: MarkdownSettings

Read-only property.

ocr_settings 

@classproperty
def ocr_settings(cls) -> OcrSettings

Gets the settings for ocr.

Type: OcrSettings

Read-only property.

open_ai_api_endpoint_settings 

@classproperty
def open_ai_api_endpoint_settings(cls) -> OpenAIApiEndpointSettings

Gets the settings for openaiapiendpoint.

Type: OpenAIApiEndpointSettings

Read-only property.

open_ai_languages_detection_settings 

@classproperty
def open_ai_languages_detection_settings(cls) -> OpenAILanguagesDetectionSettings

Gets the settings for openailanguagesdetection.

Type: OpenAILanguagesDetectionSettings

Read-only property.

open_ai_picture_alt_settings 

@classproperty
def open_ai_picture_alt_settings(cls) -> OpenAIPictureAltSettings

Gets the settings for openaipicturealt.

Type: OpenAIPictureAltSettings

Read-only property.

open_settings 

@classproperty
def open_settings(cls) -> OpenSettings

Gets the settings for opening documents.

Type: OpenSettings

Read-only property.

pdf_page_settings 

@classproperty
def pdf_page_settings(cls) -> PdfPageSettings

Gets the settings for PDF page.

Type: PdfPageSettings

Read-only property.

pdf_settings 

@classproperty
def pdf_settings(cls) -> PdfSettings

Gets the settings for PDF.

Type: PdfSettings

Read-only property.

reading_order_settings 

@classproperty
def reading_order_settings(cls) -> ReadingOrderSettings

Gets the settings for readingorder.

Type: ReadingOrderSettings

Read-only property.

segmenter_settings 

@classproperty
def segmenter_settings(cls) -> SegmenterSettings

Gets the settings for segmenter.

Type: SegmenterSettings

Read-only property.

spreadsheet_settings 

@classproperty
def spreadsheet_settings(cls) -> SpreadsheetSettings

Gets the settings for spreadsheet.

Type: SpreadsheetSettings

Read-only property.

table_recognition_settings 

@classproperty
def table_recognition_settings(cls) -> TableRecognitionSettings

Gets the settings for tablerecognition.

Type: TableRecognitionSettings

Read-only property.

tiff_settings 

@classproperty
def tiff_settings(cls) -> TiffSettings

Gets the settings for tiff.

Type: TiffSettings

Read-only property.

vision_descriptor_settings 

@classproperty
def vision_descriptor_settings(cls) -> VisionDescriptorSettings

Gets the settings for visiondescriptor.

Type: VisionDescriptorSettings

Read-only property.

vision_settings 

@classproperty
def vision_settings(cls) -> VisionSettings

Gets the settings for vision.

Type: VisionSettings

Read-only property.

words_detection_settings 

@classproperty
def words_detection_settings(cls) -> WordsDetectionSettings

Gets the settings for wordsdetection.

Type: WordsDetectionSettings

Read-only property.

word_settings 

@classproperty
def word_settings(cls) -> WordSettings

Gets the settings for Word documents.

Type: WordSettings

Read-only property.