Nutrient Java SDK/io.nutrient.sdk.settings/AiProcessingSettings

AiProcessingSettings

public final class AiProcessingSettings

Settings for AiProcessing. 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.

Constructors

Link copied to clipboard
public void AiProcessingSettings()

Functions

Link copied to clipboard
public final String getApiKey()
API key for the configured provider.
Link copied to clipboard
public final String getEndpoint()
Endpoint URL for Azure or local providers.
Link copied to clipboard
public final boolean getIncludeCompositeConfidence()
Daemon-level default for whether the single rolled-up composite confidence number is attached to result.json metadata leaves (the individual signals are surfaced whenever is on; this controls only the composite).
Link copied to clipboard
public final boolean getIncludeConfidence()
Daemon-level default for whether AI processing capacities emit confidence output - the confidence.json sidecar and the per-field confidence signals on result.json metadata.
Link copied to clipboard
public final boolean getIncludeSourceLocations()
Whether extraction grounds each extracted field back to its source location in the document — the metadata node of result.json with per-field match labels and source bounding boxes.
Link copied to clipboard
public final int getMaxAttempts()
Maximum retry attempts on structured-output failure.
Link copied to clipboard
public final String getModel()
Model identifier (e.g.
Link copied to clipboard
public final String getProvider()
Provider discriminator.
Link copied to clipboard
public final boolean getStrictStructuredOutput()
Opt-in (default ): when true, structured output runs in the provider's strict mode — the response is grammar-constrained to the schema, which is normalized automatically (additionalProperties: false, all properties required, unsupported keywords moved into descriptions).
Link copied to clipboard
public final double getTemperature()
Sampling temperature passed to the model.
Link copied to clipboard
public final void setApiKey(String value)
API key for the configured provider.
Link copied to clipboard
public final void setEndpoint(String value)
Endpoint URL for Azure or local providers.
Link copied to clipboard
public final void setIncludeCompositeConfidence(boolean value)
Daemon-level default for whether the single rolled-up composite confidence number is attached to result.json metadata leaves (the individual signals are surfaced whenever is on; this controls only the composite).
Link copied to clipboard
public final void setIncludeConfidence(boolean value)
Daemon-level default for whether AI processing capacities emit confidence output - the confidence.json sidecar and the per-field confidence signals on result.json metadata.
Link copied to clipboard
public final void setIncludeSourceLocations(boolean value)
Whether extraction grounds each extracted field back to its source location in the document — the metadata node of result.json with per-field match labels and source bounding boxes.
Link copied to clipboard
public final void setMaxAttempts(Integer value)
Maximum retry attempts on structured-output failure.
Link copied to clipboard
public final void setModel(String value)
Model identifier (e.g.
Link copied to clipboard
public final void setProvider(String value)
Provider discriminator.
Link copied to clipboard
public final void setStrictStructuredOutput(boolean value)
Opt-in (default ): when true, structured output runs in the provider's strict mode — the response is grammar-constrained to the schema, which is normalized automatically (additionalProperties: false, all properties required, unsupported keywords moved into descriptions).
Link copied to clipboard
public final void setTemperature(Double value)
Sampling temperature passed to the model.