FormLabelingSettings

Settings for FormLabeling. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document’s settings, otherwise the SDK globally when set on SdkSettings.

using Nutrient;

The SDK creates this class through factory methods or other SDK objects.

Properties

CandidateLabels

public string CandidateLabels { get; set; }

Gets or sets the value of CandidateLabels. Reads walk the chain: Document override → SDK override → Default. Writes go to document level if available, otherwise SDK level.

Type: string

EnableAiLabeling

public bool EnableAiLabeling { get; set; }

Gets or sets the value of EnableAiLabeling. Reads walk the chain: Document override → SDK override → Default. Writes go to document level if available, otherwise SDK level.

Type: bool

EnableAiRemoveFalsePositives

public bool EnableAiRemoveFalsePositives { get; set; }

Gets or sets the value of EnableAiRemoveFalsePositives. Reads walk the chain: Document override → SDK override → Default. Writes go to document level if available, otherwise SDK level.

Type: bool

EnrichmentModel

public FormVlmEnrichmentModel EnrichmentModel { get; set; }

Gets or sets the value of EnrichmentModel. Reads walk the chain: Document override → SDK override → Default. Writes go to document level if available, otherwise SDK level.

Type: FormVlmEnrichmentModel

FallbackEnrichmentModel

public int FallbackEnrichmentModel { get; }

Gets or sets the value of FallbackEnrichmentModel. Reads walk the chain: Document override → SDK override → Default. Writes go to document level if available, otherwise SDK level.

Type: int

Methods

SetFallbackEnrichmentModel

public void SetFallbackEnrichmentModel(FormVlmEnrichmentModel? value = null)

Optional fallback flow, retried on the whole document when EnrichmentModel fails outright — its connection can’t be reached, or, for Specialist, every page failed. null (the default) means no document-level fallback: a primary failure fails the call, and an individual failed Specialist page still just degrades to detector-only output, exactly as when no fallback is configured. When set to Specialist, the fallback connection comes from FormVlmFallbackConnectionSettings — independent of FormVlmConnectionSettings, so primary and fallback can point at two different dedicated endpoints. When set to Generalist, the provider comes from FallbackProvider (which must be configured to a real provider) and its matching per-provider settings class.

Parameters

Resource management

public void Dispose()

FormLabelingSettings implements IDisposable. Call Dispose() or use a C# using declaration to release its native handle right away. If you don’t, the handle is released when the object is garbage collected.