DocumentSettings

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

using Nutrient;

Construction

public DocumentSettings()

Properties

AccessibilitySettings

public AccessibilitySettings AccessibilitySettings { get; }

Gets the settings for accessibility.

Type: AccessibilitySettings

AiAugmenterSettings

public AiAugmenterSettings AiAugmenterSettings { get; }

Gets the settings for aiaugmenter.

Type: AiAugmenterSettings

AiProcessingSettings

public AiProcessingSettings AiProcessingSettings { get; }

Gets the settings for aiprocessing.

Type: AiProcessingSettings

AnthropicApiSettings

public AnthropicApiSettings AnthropicApiSettings { get; }

Gets the settings for anthropicapi.

Type: AnthropicApiSettings

CadSettings

public CadSettings CadSettings { get; }

Gets the settings for CAD.

Type: CadSettings

ContentExtractionSettings

public ContentExtractionSettings ContentExtractionSettings { get; }

Gets the settings for contentextraction.

Type: ContentExtractionSettings

ConversionSettings

public ConversionSettings ConversionSettings { get; }

Gets the settings for conversion.

Type: ConversionSettings

CustomVlmApiSettings

public CustomVlmApiSettings CustomVlmApiSettings { get; }

Gets the settings for customvlmapi.

Type: CustomVlmApiSettings

DeskewSettings

public DeskewSettings DeskewSettings { get; }

Gets the settings for deskew.

Type: DeskewSettings

DocumentClassificationSettings

public DocumentClassificationSettings DocumentClassificationSettings { get; }

Gets the settings for documentclassification.

Type: DocumentClassificationSettings

DocumentLayoutJsonExportSettings

public DocumentLayoutJsonExportSettings DocumentLayoutJsonExportSettings { get; }

Gets the settings for documentlayoutjsonexport.

Type: DocumentLayoutJsonExportSettings

DocumentSplitSettings

public DocumentSplitSettings DocumentSplitSettings { get; }

Gets the settings for documentsplit.

Type: DocumentSplitSettings

EmailSettings

public EmailSettings EmailSettings { get; }

Gets the settings for email.

Type: EmailSettings

ExtractSettings

public ExtractSettings ExtractSettings { get; }

Gets the settings for extract.

Type: ExtractSettings

FinalizerSettings

public FinalizerSettings FinalizerSettings { get; }

Gets the settings for finalizer.

Type: FinalizerSettings

FormLabelingSettings

public FormLabelingSettings FormLabelingSettings { get; }

Gets the settings for formlabeling.

Type: FormLabelingSettings

FormRecognitionSettings

public FormRecognitionSettings FormRecognitionSettings { get; }

Gets the settings for formrecognition.

Type: FormRecognitionSettings

FormVlmConnectionSettings

public FormVlmConnectionSettings FormVlmConnectionSettings { get; }

Gets the settings for formvlmconnection.

Type: FormVlmConnectionSettings

FormVlmFallbackConnectionSettings

public FormVlmFallbackConnectionSettings FormVlmFallbackConnectionSettings { get; }

Gets the settings for formvlmfallbackconnection.

Type: FormVlmFallbackConnectionSettings

GoogleApiSettings

public GoogleApiSettings GoogleApiSettings { get; }

Gets the settings for googleapi.

Type: GoogleApiSettings

HandwritingSettings

public HandwritingSettings HandwritingSettings { get; }

Gets the settings for handwriting.

Type: HandwritingSettings

HtmlSettings

public HtmlSettings HtmlSettings { get; }

Gets the settings for HTML.

Type: HtmlSettings

ImageSettings

public ImageSettings ImageSettings { get; }

Gets the settings for image.

Type: ImageSettings

InferenceLayoutSettings

public InferenceLayoutSettings InferenceLayoutSettings { get; }

Gets the settings for inferencelayout.

Type: InferenceLayoutSettings

InlineStyleSettings

public InlineStyleSettings InlineStyleSettings { get; }

Gets the settings for inlinestyle.

Type: InlineStyleSettings

InstantJsonSettings

public InstantJsonSettings InstantJsonSettings { get; }

Gets the settings for instantjson.

Type: InstantJsonSettings

Jbig2Settings

public Jbig2Settings Jbig2Settings { get; }

Gets the settings for jbig2.

Type: Jbig2Settings

JpegSettings

public JpegSettings JpegSettings { get; }

Gets the settings for jpeg.

Type: JpegSettings

LocalAiProcessingSettings

public LocalAiProcessingSettings LocalAiProcessingSettings { get; }

Gets the settings for localaiprocessing.

Type: LocalAiProcessingSettings

LocalVlmSettings

public LocalVlmSettings LocalVlmSettings { get; }

Gets the settings for localvlm.

Type: LocalVlmSettings

MarkdownSettings

public MarkdownSettings MarkdownSettings { get; }

Gets the settings for markdown.

Type: MarkdownSettings

OcrSettings

public OcrSettings OcrSettings { get; }

Gets the settings for ocr.

Type: OcrSettings

OmrSettings

public OmrSettings OmrSettings { get; }

Gets the settings for omr.

Type: OmrSettings

OpenAIApiEndpointSettings

public OpenAIApiEndpointSettings OpenAIApiEndpointSettings { get; }

Gets the settings for openaiapiendpoint.

Type: OpenAIApiEndpointSettings

OpenAILanguagesDetectionSettings

public OpenAILanguagesDetectionSettings OpenAILanguagesDetectionSettings { get; }

Gets the settings for openailanguagesdetection.

Type: OpenAILanguagesDetectionSettings

OpenAIPictureAltSettings

public OpenAIPictureAltSettings OpenAIPictureAltSettings { get; }

Gets the settings for openaipicturealt.

Type: OpenAIPictureAltSettings

OpenSettings

public OpenSettings OpenSettings { get; }

Gets the settings for opening documents.

Type: OpenSettings

PPTextDetSettings

public PPTextDetSettings PPTextDetSettings { get; }

Gets the settings for pptextdet.

Type: PPTextDetSettings

PPTextRecSettings

public PPTextRecSettings PPTextRecSettings { get; }

Gets the settings for pptextrec.

Type: PPTextRecSettings

ParseSettings

public ParseSettings ParseSettings { get; }

Gets the settings for parse.

Type: ParseSettings

PdfPageSettings

public PdfPageSettings PdfPageSettings { get; }

Gets the settings for PDF page.

Type: PdfPageSettings

PdfSettings

public PdfSettings PdfSettings { get; }

Gets the settings for PDF.

Type: PdfSettings

PreprocessingSettings

public PreprocessingSettings PreprocessingSettings { get; }

Gets the settings for preprocessing.

Type: PreprocessingSettings

PresentationSettings

public PresentationSettings PresentationSettings { get; }

Gets the settings for presentation.

Type: PresentationSettings

ReadingOrderSettings

public ReadingOrderSettings ReadingOrderSettings { get; }

Gets the settings for readingorder.

Type: ReadingOrderSettings

SchemaGenerationSettings

public SchemaGenerationSettings SchemaGenerationSettings { get; }

Gets the settings for schemageneration.

Type: SchemaGenerationSettings

SearchSettings

public SearchSettings SearchSettings { get; }

Gets the settings for search.

Type: SearchSettings

SegmenterSettings

public SegmenterSettings SegmenterSettings { get; }

Gets the settings for segmenter.

Type: SegmenterSettings

SpreadsheetSettings

public SpreadsheetSettings SpreadsheetSettings { get; }

Gets the settings for spreadsheet.

Type: SpreadsheetSettings

TableDetectionSettings

public TableDetectionSettings TableDetectionSettings { get; }

Gets the settings for tabledetection.

Type: TableDetectionSettings

TableRecognitionSettings

public TableRecognitionSettings TableRecognitionSettings { get; }

Gets the settings for tablerecognition.

Type: TableRecognitionSettings

TextSettings

public TextSettings TextSettings { get; }

Gets the settings for text.

Type: TextSettings

TiffSettings

public TiffSettings TiffSettings { get; }

Gets the settings for tiff.

Type: TiffSettings

VisionAccelerationSettings

public VisionAccelerationSettings VisionAccelerationSettings { get; }

Gets the settings for visionacceleration.

Type: VisionAccelerationSettings

VisionDescriptorSettings

public VisionDescriptorSettings VisionDescriptorSettings { get; }

Gets the settings for visiondescriptor.

Type: VisionDescriptorSettings

VisionSettings

public VisionSettings VisionSettings { get; }

Gets the settings for vision.

Type: VisionSettings

WordSettings

public WordSettings WordSettings { get; }

Gets the settings for Word documents.

Type: WordSettings

WordsDetectionSettings

public WordsDetectionSettings WordsDetectionSettings { get; }

Gets the settings for wordsdetection.

Type: WordsDetectionSettings

Methods

Export

public void Export(string path)

Exports the current document settings to a JSON file.

Parameters

Name	Type	Description
`path`	`string`	The file path where the JSON settings will be saved.

Load

public void Load(string path)

Loads document settings from a JSON file.