DocumentSettings

Provides configuration settings for SDK document operations. Manages document-level settings with overrides over SDK defaults.

from nutrient import DocumentSettings

Methods

export

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

Exports the current document settings to a JSON file.

Parameters:

load

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

Loads document settings from a JSON file.

Parameters:

Properties

ai_augmenter_settings

@property
def ai_augmenter_settings(self) -> AiAugmenterSettings

Gets the settings for aiaugmenter.

Type: AiAugmenterSettings

Read-only property.

cad_settings

@property
def cad_settings(self) -> CadSettings

Gets the settings for CAD.

Type: CadSettings

Read-only property.

claude_api_settings

@property
def claude_api_settings(self) -> ClaudeApiSettings

Gets the settings for claudeapi.

Type: ClaudeApiSettings

Read-only property.

content_extraction_settings

@property
def content_extraction_settings(self) -> ContentExtractionSettings

Gets the settings for contentextraction.

Type: ContentExtractionSettings

Read-only property.

conversion_settings

@property
def conversion_settings(self) -> ConversionSettings

Gets the settings for conversion.

Type: ConversionSettings

Read-only property.

custom_vlm_api_settings

@property
def custom_vlm_api_settings(self) -> CustomVlmApiSettings

Gets the settings for customvlmapi.

Type: CustomVlmApiSettings

Read-only property.

document_layout_json_export_settings

@property
def document_layout_json_export_settings(self) -> DocumentLayoutJsonExportSettings

Gets the settings for documentlayoutjsonexport.

Type: DocumentLayoutJsonExportSettings

Read-only property.

finalizer_settings

@property
def finalizer_settings(self) -> FinalizerSettings

Gets the settings for finalizer.

Type: FinalizerSettings

Read-only property.

html_settings

@property
def html_settings(self) -> HtmlSettings

Gets the settings for HTML.

Type: HtmlSettings

Read-only property.

image_settings

@property
def image_settings(self) -> ImageSettings

Gets the settings for image.

Type: ImageSettings

Read-only property.

inference_layout_settings

@property
def inference_layout_settings(self) -> InferenceLayoutSettings

Gets the settings for inferencelayout.

Type: InferenceLayoutSettings

Read-only property.

jbig2_settings

@property
def jbig2_settings(self) -> Jbig2Settings

Gets the settings for jbig2.

Type: Jbig2Settings

Read-only property.

jpeg_settings

@property
def jpeg_settings(self) -> JpegSettings

Gets the settings for jpeg.

Type: JpegSettings

Read-only property.

ocr_settings

@property
def ocr_settings(self) -> OcrSettings

Gets the settings for ocr.

Type: OcrSettings

Read-only property.

open_ai_api_endpoint_settings

@property
def open_ai_api_endpoint_settings(self) -> OpenAIApiEndpointSettings

Gets the settings for openaiapiendpoint.

Type: OpenAIApiEndpointSettings

Read-only property.

open_ai_languages_detection_settings

@property
def open_ai_languages_detection_settings(self) -> OpenAILanguagesDetectionSettings

Gets the settings for openailanguagesdetection.

Type: OpenAILanguagesDetectionSettings

Read-only property.

open_ai_picture_alt_settings

@property
def open_ai_picture_alt_settings(self) -> OpenAIPictureAltSettings

Gets the settings for openaipicturealt.

Type: OpenAIPictureAltSettings

Read-only property.

open_settings

@property
def open_settings(self) -> OpenSettings

Gets the settings for opening documents.

Type: OpenSettings

Read-only property.

pdf_page_settings

@property
def pdf_page_settings(self) -> PdfPageSettings

Gets the settings for PDF page.

Type: PdfPageSettings

Read-only property.

pdf_settings

@property
def pdf_settings(self) -> PdfSettings

Gets the settings for PDF.

Type: PdfSettings

Read-only property.

presentation_settings

@property
def presentation_settings(self) -> PresentationSettings

Gets the settings for presentation.

Type: PresentationSettings

Read-only property.

reading_order_settings

@property
def reading_order_settings(self) -> ReadingOrderSettings

Gets the settings for readingorder.

Type: ReadingOrderSettings

Read-only property.

segmenter_settings

@property
def segmenter_settings(self) -> SegmenterSettings

Gets the settings for segmenter.

Type: SegmenterSettings

Read-only property.

spreadsheet_settings

@property
def spreadsheet_settings(self) -> SpreadsheetSettings

Gets the settings for spreadsheet.

Type: SpreadsheetSettings

Read-only property.

table_recognition_settings

@property
def table_recognition_settings(self) -> TableRecognitionSettings

Gets the settings for tablerecognition.

Type: TableRecognitionSettings

Read-only property.

tiff_settings

@property
def tiff_settings(self) -> TiffSettings

Gets the settings for tiff.

Type: TiffSettings

Read-only property.

vision_descriptor_settings

@property
def vision_descriptor_settings(self) -> VisionDescriptorSettings

Gets the settings for visiondescriptor.

Type: VisionDescriptorSettings

Read-only property.

vision_settings

@property
def vision_settings(self) -> VisionSettings

Gets the settings for vision.

Type: VisionSettings

Read-only property.

words_detection_settings

@property
def words_detection_settings(self) -> WordsDetectionSettings

Gets the settings for wordsdetection.

Type: WordsDetectionSettings

Read-only property.

word_settings

@property
def word_settings(self) -> WordSettings

Gets the settings for Word documents.

Type: WordSettings

Read-only property.