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.
using Nutrient;SdkSettings is a static class: call its members on the class itself.
Properties
AccessibilitySettings
public static AccessibilitySettings AccessibilitySettings { get; }Gets the settings for accessibility.
Type: AccessibilitySettings
AiAugmenterSettings
public static AiAugmenterSettings AiAugmenterSettings { get; }Gets the settings for aiaugmenter.
Type: AiAugmenterSettings
AiProcessingSettings
public static AiProcessingSettings AiProcessingSettings { get; }Gets the settings for aiprocessing.
Type: AiProcessingSettings
AnthropicApiSettings
public static AnthropicApiSettings AnthropicApiSettings { get; }Gets the settings for anthropicapi.
Type: AnthropicApiSettings
CadSettings
public static CadSettings CadSettings { get; }Gets the settings for CAD.
Type: CadSettings
ContentExtractionSettings
public static ContentExtractionSettings ContentExtractionSettings { get; }Gets the settings for contentextraction.
Type: ContentExtractionSettings
ConversionSettings
public static ConversionSettings ConversionSettings { get; }Gets the settings for conversion.
Type: ConversionSettings
CustomVlmApiSettings
public static CustomVlmApiSettings CustomVlmApiSettings { get; }Gets the settings for customvlmapi.
Type: CustomVlmApiSettings
DeskewSettings
public static DeskewSettings DeskewSettings { get; }Gets the settings for deskew.
Type: DeskewSettings
DocumentClassificationSettings
public static DocumentClassificationSettings DocumentClassificationSettings { get; }Gets the settings for documentclassification.
Type: DocumentClassificationSettings
DocumentLayoutJsonExportSettings
public static DocumentLayoutJsonExportSettings DocumentLayoutJsonExportSettings { get; }Gets the settings for documentlayoutjsonexport.
Type: DocumentLayoutJsonExportSettings
DocumentSplitSettings
public static DocumentSplitSettings DocumentSplitSettings { get; }Gets the settings for documentsplit.
Type: DocumentSplitSettings
EmailSettings
public static EmailSettings EmailSettings { get; }Gets the settings for email.
Type: EmailSettings
ExtractSettings
public static ExtractSettings ExtractSettings { get; }Gets the settings for extract.
Type: ExtractSettings
FinalizerSettings
public static FinalizerSettings FinalizerSettings { get; }Gets the settings for finalizer.
Type: FinalizerSettings
FormLabelingSettings
public static FormLabelingSettings FormLabelingSettings { get; }Gets the settings for formlabeling.
Type: FormLabelingSettings
FormRecognitionSettings
public static FormRecognitionSettings FormRecognitionSettings { get; }Gets the settings for formrecognition.
Type: FormRecognitionSettings
FormVlmConnectionSettings
public static FormVlmConnectionSettings FormVlmConnectionSettings { get; }Gets the settings for formvlmconnection.
Type: FormVlmConnectionSettings
FormVlmFallbackConnectionSettings
public static FormVlmFallbackConnectionSettings FormVlmFallbackConnectionSettings { get; }Gets the settings for formvlmfallbackconnection.
Type: FormVlmFallbackConnectionSettings
GoogleApiSettings
public static GoogleApiSettings GoogleApiSettings { get; }Gets the settings for googleapi.
Type: GoogleApiSettings
HandwritingSettings
public static HandwritingSettings HandwritingSettings { get; }Gets the settings for handwriting.
Type: HandwritingSettings
HtmlSettings
public static HtmlSettings HtmlSettings { get; }Gets the settings for HTML.
Type: HtmlSettings
ImageSettings
public static ImageSettings ImageSettings { get; }Gets the settings for image.
Type: ImageSettings
InferenceLayoutSettings
public static InferenceLayoutSettings InferenceLayoutSettings { get; }Gets the settings for inferencelayout.
Type: InferenceLayoutSettings
InlineStyleSettings
public static InlineStyleSettings InlineStyleSettings { get; }Gets the settings for inlinestyle.
Type: InlineStyleSettings
InstantJsonSettings
public static InstantJsonSettings InstantJsonSettings { get; }Gets the settings for instantjson.
Type: InstantJsonSettings
Jbig2Settings
public static Jbig2Settings Jbig2Settings { get; }Gets the settings for jbig2.
Type: Jbig2Settings
JpegSettings
public static JpegSettings JpegSettings { get; }Gets the settings for jpeg.
Type: JpegSettings
LocalAiProcessingSettings
public static LocalAiProcessingSettings LocalAiProcessingSettings { get; }Gets the settings for localaiprocessing.
Type: LocalAiProcessingSettings
LocalVlmSettings
public static LocalVlmSettings LocalVlmSettings { get; }Gets the settings for localvlm.
Type: LocalVlmSettings
MarkdownSettings
public static MarkdownSettings MarkdownSettings { get; }Gets the settings for markdown.
Type: MarkdownSettings
OcrSettings
public static OcrSettings OcrSettings { get; }Gets the settings for ocr.
Type: OcrSettings
OmrSettings
public static OmrSettings OmrSettings { get; }Gets the settings for omr.
Type: OmrSettings
OpenAIApiEndpointSettings
public static OpenAIApiEndpointSettings OpenAIApiEndpointSettings { get; }Gets the settings for openaiapiendpoint.
Type: OpenAIApiEndpointSettings
OpenAILanguagesDetectionSettings
public static OpenAILanguagesDetectionSettings OpenAILanguagesDetectionSettings { get; }Gets the settings for openailanguagesdetection.
Type: OpenAILanguagesDetectionSettings
OpenAIPictureAltSettings
public static OpenAIPictureAltSettings OpenAIPictureAltSettings { get; }Gets the settings for openaipicturealt.
Type: OpenAIPictureAltSettings
OpenSettings
public static OpenSettings OpenSettings { get; }Gets the settings for opening documents.
Type: OpenSettings
PPTextDetSettings
public static PPTextDetSettings PPTextDetSettings { get; }Gets the settings for pptextdet.
Type: PPTextDetSettings
PPTextRecSettings
public static PPTextRecSettings PPTextRecSettings { get; }Gets the settings for pptextrec.
Type: PPTextRecSettings
ParseSettings
public static ParseSettings ParseSettings { get; }Gets the settings for parse.
Type: ParseSettings
PdfPageSettings
public static PdfPageSettings PdfPageSettings { get; }Gets the settings for PDF page.
Type: PdfPageSettings
PdfSettings
public static PdfSettings PdfSettings { get; }Gets the settings for PDF.
Type: PdfSettings
PreprocessingSettings
public static PreprocessingSettings PreprocessingSettings { get; }Gets the settings for preprocessing.
Type: PreprocessingSettings
PresentationSettings
public static PresentationSettings PresentationSettings { get; }Gets the settings for presentation.
Type: PresentationSettings
ReadingOrderSettings
public static ReadingOrderSettings ReadingOrderSettings { get; }Gets the settings for readingorder.
Type: ReadingOrderSettings
SchemaGenerationSettings
public static SchemaGenerationSettings SchemaGenerationSettings { get; }Gets the settings for schemageneration.
Type: SchemaGenerationSettings
SearchSettings
public static SearchSettings SearchSettings { get; }Gets the settings for search.
Type: SearchSettings
SegmenterSettings
public static SegmenterSettings SegmenterSettings { get; }Gets the settings for segmenter.
Type: SegmenterSettings
SpreadsheetSettings
public static SpreadsheetSettings SpreadsheetSettings { get; }Gets the settings for spreadsheet.
Type: SpreadsheetSettings
TableDetectionSettings
public static TableDetectionSettings TableDetectionSettings { get; }Gets the settings for tabledetection.
Type: TableDetectionSettings
TableRecognitionSettings
public static TableRecognitionSettings TableRecognitionSettings { get; }Gets the settings for tablerecognition.
Type: TableRecognitionSettings
TextSettings
public static TextSettings TextSettings { get; }Gets the settings for text.
Type: TextSettings
TiffSettings
public static TiffSettings TiffSettings { get; }Gets the settings for tiff.
Type: TiffSettings
VisionAccelerationSettings
public static VisionAccelerationSettings VisionAccelerationSettings { get; }Gets the settings for visionacceleration.
Type: VisionAccelerationSettings
VisionDescriptorSettings
public static VisionDescriptorSettings VisionDescriptorSettings { get; }Gets the settings for visiondescriptor.
Type: VisionDescriptorSettings
VisionSettings
public static VisionSettings VisionSettings { get; }Gets the settings for vision.
Type: VisionSettings
WordSettings
public static WordSettings WordSettings { get; }Gets the settings for Word documents.
Type: WordSettings
WordsDetectionSettings
public static WordsDetectionSettings WordsDetectionSettings { get; }Gets the settings for wordsdetection.
Type: WordsDetectionSettings
Methods
Export
public static void Export(string path)Static method to export the current SDK settings to a JSON file.
Parameters
| Name | Type | Description |
|---|---|---|
path | string | The file path where the JSON settings will be saved. |
public static void Export(Stream stream)Static method to export the current SDK settings to a JSON stream.
Parameters
| Name | Type | Description |
|---|---|---|
stream | Stream | The stream to write the JSON-formatted settings to. |
Load
public static void Load(string path)Static method to load SDK settings from a JSON file.
Parameters
| Name | Type | Description |
|---|---|---|
path | string | The file path to the JSON settings file. |
public static void Load(Stream stream)Static method to load SDK settings from a JSON stream.
Parameters
| Name | Type | Description |
|---|---|---|
stream | Stream | The stream containing JSON-formatted SDK settings. |