SdkSettings

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.

from nutrient import SdkSettings

Class Methods

export

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

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

Parameters:

get_ai_augmenter_settings

@classmethod
def get_ai_augmenter_settings(cls) -> AiAugmenterSettings

Gets the settings for aiaugmenter.

Returns: AiAugmenterSettings

get_cad_settings

@classmethod
def get_cad_settings(cls) -> CadSettings

Gets the settings for CAD.

Returns: CadSettings

get_claude_api_settings

@classmethod
def get_claude_api_settings(cls) -> ClaudeApiSettings

Gets the settings for claudeapi.

Returns: ClaudeApiSettings

get_content_extraction_settings

@classmethod
def get_content_extraction_settings(cls) -> ContentExtractionSettings

Gets the settings for contentextraction.

Returns: ContentExtractionSettings

get_conversion_settings

@classmethod
def get_conversion_settings(cls) -> ConversionSettings

Gets the settings for conversion.

Returns: ConversionSettings

get_custom_vlm_api_settings

@classmethod
def get_custom_vlm_api_settings(cls) -> CustomVlmApiSettings

Gets the settings for customvlmapi.

Returns: CustomVlmApiSettings

get_document_layout_json_export_settings

@classmethod
def get_document_layout_json_export_settings(cls) -> DocumentLayoutJsonExportSettings

Gets the settings for documentlayoutjsonexport.

Returns: DocumentLayoutJsonExportSettings

get_finalizer_settings

@classmethod
def get_finalizer_settings(cls) -> FinalizerSettings

Gets the settings for finalizer.

Returns: FinalizerSettings

get_html_settings

@classmethod
def get_html_settings(cls) -> HtmlSettings

Gets the settings for HTML.

Returns: HtmlSettings

get_image_settings

@classmethod
def get_image_settings(cls) -> ImageSettings

Gets the settings for image.

Returns: ImageSettings

get_inference_layout_settings

@classmethod
def get_inference_layout_settings(cls) -> InferenceLayoutSettings

Gets the settings for inferencelayout.

Returns: InferenceLayoutSettings

get_jbig2_settings

@classmethod
def get_jbig2_settings(cls) -> Jbig2Settings

Gets the settings for jbig2.

Returns: Jbig2Settings

get_jpeg_settings

@classmethod
def get_jpeg_settings(cls) -> JpegSettings

Gets the settings for jpeg.

Returns: JpegSettings

get_ocr_settings

@classmethod
def get_ocr_settings(cls) -> OcrSettings

Gets the settings for ocr.

Returns: OcrSettings

get_open_ai_api_endpoint_settings

@classmethod
def get_open_ai_api_endpoint_settings(cls) -> OpenAIApiEndpointSettings

Gets the settings for openaiapiendpoint.

Returns: OpenAIApiEndpointSettings

get_open_ai_languages_detection_settings

@classmethod
def get_open_ai_languages_detection_settings(cls) -> OpenAILanguagesDetectionSettings

Gets the settings for openailanguagesdetection.

Returns: OpenAILanguagesDetectionSettings

get_open_ai_picture_alt_settings

@classmethod
def get_open_ai_picture_alt_settings(cls) -> OpenAIPictureAltSettings

Gets the settings for openaipicturealt.

Returns: OpenAIPictureAltSettings

get_open_settings

@classmethod
def get_open_settings(cls) -> OpenSettings

Gets the settings for opening documents.

Returns: OpenSettings

get_pdf_page_settings

@classmethod
def get_pdf_page_settings(cls) -> PdfPageSettings

Gets the settings for PDF page.

Returns: PdfPageSettings

get_pdf_settings

@classmethod
def get_pdf_settings(cls) -> PdfSettings

Gets the settings for PDF.

Returns: PdfSettings

get_presentation_settings

@classmethod
def get_presentation_settings(cls) -> PresentationSettings

Gets the settings for presentation.

Returns: PresentationSettings

get_reading_order_settings

@classmethod
def get_reading_order_settings(cls) -> ReadingOrderSettings

Gets the settings for readingorder.

Returns: ReadingOrderSettings

get_segmenter_settings

@classmethod
def get_segmenter_settings(cls) -> SegmenterSettings

Gets the settings for segmenter.

Returns: SegmenterSettings

get_spreadsheet_settings

@classmethod
def get_spreadsheet_settings(cls) -> SpreadsheetSettings

Gets the settings for spreadsheet.

Returns: SpreadsheetSettings

get_table_recognition_settings

@classmethod
def get_table_recognition_settings(cls) -> TableRecognitionSettings

Gets the settings for tablerecognition.

Returns: TableRecognitionSettings

get_tiff_settings

@classmethod
def get_tiff_settings(cls) -> TiffSettings

Gets the settings for tiff.

Returns: TiffSettings

get_vision_descriptor_settings

@classmethod
def get_vision_descriptor_settings(cls) -> VisionDescriptorSettings

Gets the settings for visiondescriptor.

Returns: VisionDescriptorSettings

get_vision_settings

@classmethod
def get_vision_settings(cls) -> VisionSettings

Gets the settings for vision.

Returns: VisionSettings

get_words_detection_settings

@classmethod
def get_words_detection_settings(cls) -> WordsDetectionSettings

Gets the settings for wordsdetection.

Returns: WordsDetectionSettings

get_word_settings

@classmethod
def get_word_settings(cls) -> WordSettings

Gets the settings for Word documents.

Returns: WordSettings

load

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

Static method to load SDK settings from a JSON file.

Parameters:

Methods

export_instance

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

Exports the current SDK settings to a JSON file.

Parameters:

load_instance

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

Loads SDK settings from a JSON file.

Parameters: