--- title: "SdkSettings" canonical_url: "https://www.nutrient.io/api/python/settings/document/sdk-settings/" md_url: "https://www.nutrient.io/api/python/settings/document/sdk-settings.md" last_updated: "2026-06-12T15:43:20.744Z" description: "Manages configuration settings for the Nutrient SDK. Provides functionality to load, export, and access various SDK settings through a type-safe registry syste…" --- 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` ```python from nutrient_sdk import SdkSettings ``` ## Construction ```python SdkSettings() ``` Creates a new `SdkSettings` instance with default settings. ## Class Methods ### export ```python @classmethod def export(cls, path: str) -> None ``` Static method to export the current SDK settings to a JSON file. **Parameters:** | Name | Type | Description | | ------ | ----- | ---------------------------------------------------- | | `path` | `str` | The file path where the JSON settings will be saved. | --- ### load ```python @classmethod def load(cls, path: str) -> None ``` Static method to load SDK settings from a JSON file. **Parameters:** | Name | Type | Description | | ------ | ----- | ---------------------------------------- | | `path` | `str` | The file path to the JSON settings file. | --- ## Methods ### export_instance ```python def export_instance(self, path: str) -> None ``` Exports the current SDK settings to a JSON file. **Parameters:** | Name | Type | Description | | ------ | ----- | ---------------------------------------------------- | | `path` | `str` | The file path where the JSON settings will be saved. | --- ### load_instance ```python def load_instance(self, path: str) -> None ``` Loads SDK settings from a JSON file. **Parameters:** | Name | Type | Description | | ------ | ----- | ---------------------------------------- | | `path` | `str` | The file path to the JSON settings file. | --- ## Properties ### ai_augmenter_settings ```python @classproperty def ai_augmenter_settings(cls) -> AiAugmenterSettings ``` Gets the settings for aiaugmenter. **Type:** [`AiAugmenterSettings`](/api/python/settings/vision/advanced/ai-augmenter-settings/) *Read-only property.* --- ### ai_processing_settings ```python @classproperty def ai_processing_settings(cls) -> AiProcessingSettings ``` Gets the settings for aiprocessing. **Type:** [`AiProcessingSettings`](/api/python/settings/advanced/vision/ai-processing-settings/) *Read-only property.* --- ### cad_settings ```python @classproperty def cad_settings(cls) -> CadSettings ``` Gets the settings for CAD. **Type:** [`CadSettings`](/api/python/settings/format/cad-settings/) *Read-only property.* --- ### claude_api_settings ```python @classproperty def claude_api_settings(cls) -> ClaudeApiSettings ``` Gets the settings for claudeapi. **Type:** [`ClaudeApiSettings`](/api/python/settings/vision/advanced/claude-api-settings/) *Read-only property.* --- ### content_extraction_settings ```python @classproperty def content_extraction_settings(cls) -> ContentExtractionSettings ``` Gets the settings for contentextraction. **Type:** [`ContentExtractionSettings`](/api/python/settings/vision/advanced/content-extraction-settings/) *Read-only property.* --- ### conversion_settings ```python @classproperty def conversion_settings(cls) -> ConversionSettings ``` Gets the settings for conversion. **Type:** [`ConversionSettings`](/api/python/settings/document/conversion-settings/) *Read-only property.* --- ### custom_vlm_api_settings ```python @classproperty def custom_vlm_api_settings(cls) -> CustomVlmApiSettings ``` Gets the settings for customvlmapi. **Type:** [`CustomVlmApiSettings`](/api/python/settings/advanced/vision/custom-vlm-api-settings/) *Read-only property.* --- ### deskew_settings ```python @classproperty def deskew_settings(cls) -> DeskewSettings ``` Gets the settings for deskew. **Type:** [`DeskewSettings`](/api/python/settings/vision/advanced/deskew-settings/) *Read-only property.* --- ### document_layout_json_export_settings ```python @classproperty def document_layout_json_export_settings(cls) -> DocumentLayoutJsonExportSettings ``` Gets the settings for documentlayoutjsonexport. **Type:** [`DocumentLayoutJsonExportSettings`](/api/python/settings/vision/advanced/document-layout-json-export-settings/) *Read-only property.* --- ### email_settings ```python @classproperty def email_settings(cls) -> EmailSettings ``` Gets the settings for email. **Type:** [`EmailSettings`](/api/python/settings/format/email-settings/) *Read-only property.* --- ### finalizer_settings ```python @classproperty def finalizer_settings(cls) -> FinalizerSettings ``` Gets the settings for finalizer. **Type:** [`FinalizerSettings`](/api/python/settings/advanced/vision/finalizer-settings/) *Read-only property.* --- ### form_labeling_settings ```python @classproperty def form_labeling_settings(cls) -> FormLabelingSettings ``` Gets the settings for formlabeling. **Type:** [`FormLabelingSettings`](/api/python/settings/advanced/vision/form-labeling-settings/) *Read-only property.* --- ### form_recognition_settings ```python @classproperty def form_recognition_settings(cls) -> FormRecognitionSettings ``` Gets the settings for formrecognition. **Type:** [`FormRecognitionSettings`](/api/python/settings/advanced/vision/form-recognition-settings/) *Read-only property.* --- ### handwriting_settings ```python @classproperty def handwriting_settings(cls) -> HandwritingSettings ``` Gets the settings for handwriting. **Type:** [`HandwritingSettings`](/api/python/settings/vision/advanced/handwriting-settings/) *Read-only property.* --- ### html_settings ```python @classproperty def html_settings(cls) -> HtmlSettings ``` Gets the settings for HTML. **Type:** [`HtmlSettings`](/api/python/settings/format/html-settings/) *Read-only property.* --- ### image_settings ```python @classproperty def image_settings(cls) -> ImageSettings ``` Gets the settings for image. **Type:** [`ImageSettings`](/api/python/settings/format/image-settings/) *Read-only property.* --- ### inference_layout_settings ```python @classproperty def inference_layout_settings(cls) -> InferenceLayoutSettings ``` Gets the settings for inferencelayout. **Type:** [`InferenceLayoutSettings`](/api/python/settings/advanced/vision/inference-layout-settings/) *Read-only property.* --- ### instant_json_settings ```python @classproperty def instant_json_settings(cls) -> InstantJsonSettings ``` Gets the settings for instantjson. **Type:** [`InstantJsonSettings`](/api/python/settings/advanced/format/instant-json-settings/) *Read-only property.* --- ### jbig2_settings ```python @classproperty def jbig2_settings(cls) -> Jbig2Settings ``` Gets the settings for jbig2. **Type:** [`Jbig2Settings`](/api/python/settings/format/advanced/jbig2-settings/) *Read-only property.* --- ### jpeg_settings ```python @classproperty def jpeg_settings(cls) -> JpegSettings ``` Gets the settings for jpeg. **Type:** [`JpegSettings`](/api/python/settings/format/jpeg-settings/) *Read-only property.* --- ### markdown_settings ```python @classproperty def markdown_settings(cls) -> MarkdownSettings ``` Gets the settings for markdown. **Type:** [`MarkdownSettings`](/api/python/settings/format/markdown-settings/) *Read-only property.* --- ### ocr_settings ```python @classproperty def ocr_settings(cls) -> OcrSettings ``` Gets the settings for ocr. **Type:** [`OcrSettings`](/api/python/settings/advanced/vision/ocr-settings/) *Read-only property.* --- ### open_ai_api_endpoint_settings ```python @classproperty def open_ai_api_endpoint_settings(cls) -> OpenAIApiEndpointSettings ``` Gets the settings for openaiapiendpoint. **Type:** [`OpenAIApiEndpointSettings`](/api/python/settings/vision/advanced/open-ai-api-endpoint-settings/) *Read-only property.* --- ### open_ai_languages_detection_settings ```python @classproperty def open_ai_languages_detection_settings(cls) -> OpenAILanguagesDetectionSettings ``` Gets the settings for openailanguagesdetection. **Type:** [`OpenAILanguagesDetectionSettings`](/api/python/settings/advanced/vision/open-ai-languages-detection-settings/) *Read-only property.* --- ### open_ai_picture_alt_settings ```python @classproperty def open_ai_picture_alt_settings(cls) -> OpenAIPictureAltSettings ``` Gets the settings for openaipicturealt. **Type:** [`OpenAIPictureAltSettings`](/api/python/settings/advanced/vision/open-ai-picture-alt-settings/) *Read-only property.* --- ### open_settings ```python @classproperty def open_settings(cls) -> OpenSettings ``` Gets the settings for opening documents. **Type:** [`OpenSettings`](/api/python/settings/document/open-settings/) *Read-only property.* --- ### pdf_page_settings ```python @classproperty def pdf_page_settings(cls) -> PdfPageSettings ``` Gets the settings for PDF page. **Type:** [`PdfPageSettings`](/api/python/settings/format/advanced/pdf-page-settings/) *Read-only property.* --- ### pdf_settings ```python @classproperty def pdf_settings(cls) -> PdfSettings ``` Gets the settings for PDF. **Type:** [`PdfSettings`](/api/python/settings/format/pdf-settings/) *Read-only property.* --- ### reading_order_settings ```python @classproperty def reading_order_settings(cls) -> ReadingOrderSettings ``` Gets the settings for readingorder. **Type:** [`ReadingOrderSettings`](/api/python/settings/advanced/vision/reading-order-settings/) *Read-only property.* --- ### segmenter_settings ```python @classproperty def segmenter_settings(cls) -> SegmenterSettings ``` Gets the settings for segmenter. **Type:** [`SegmenterSettings`](/api/python/settings/advanced/vision/segmenter-settings/) *Read-only property.* --- ### spreadsheet_settings ```python @classproperty def spreadsheet_settings(cls) -> SpreadsheetSettings ``` Gets the settings for spreadsheet. **Type:** [`SpreadsheetSettings`](/api/python/settings/format/spreadsheet-settings/) *Read-only property.* --- ### table_recognition_settings ```python @classproperty def table_recognition_settings(cls) -> TableRecognitionSettings ``` Gets the settings for tablerecognition. **Type:** [`TableRecognitionSettings`](/api/python/settings/vision/advanced/table-recognition-settings/) *Read-only property.* --- ### tiff_settings ```python @classproperty def tiff_settings(cls) -> TiffSettings ``` Gets the settings for tiff. **Type:** [`TiffSettings`](/api/python/settings/format/advanced/tiff-settings/) *Read-only property.* --- ### vision_descriptor_settings ```python @classproperty def vision_descriptor_settings(cls) -> VisionDescriptorSettings ``` Gets the settings for visiondescriptor. **Type:** [`VisionDescriptorSettings`](/api/python/settings/vision/advanced/vision-descriptor-settings/) *Read-only property.* --- ### vision_settings ```python @classproperty def vision_settings(cls) -> VisionSettings ``` Gets the settings for vision. **Type:** [`VisionSettings`](/api/python/settings/vision/vision-settings/) *Read-only property.* --- ### words_detection_settings ```python @classproperty def words_detection_settings(cls) -> WordsDetectionSettings ``` Gets the settings for wordsdetection. **Type:** [`WordsDetectionSettings`](/api/python/settings/advanced/vision/words-detection-settings/) *Read-only property.* --- ### word_settings ```python @classproperty def word_settings(cls) -> WordSettings ``` Gets the settings for Word documents. **Type:** [`WordSettings`](/api/python/settings/format/word-settings/) *Read-only property.* --- --- ## Related pages - [Per-document override](/api/python/settings/document/open-settings.md) - [Per-document override](/api/python/settings/document/conversion-settings.md) - [Document Settings](/api/python/settings/document/document-settings.md) - [Document](/api/python/settings/document.md)