VisionSettings

public final class VisionSettings

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

Functions

Link copied to clipboard
public final boolean getAccessibleImageDescriptions()
Indicates whether VLM image descriptions should be written as screen-reader alt text.
Link copied to clipboard
public final OcrActivationMode getEnableOcr()
Controls OCR resource loading and OCR-based word detection inside the ICR image pipeline.
Link copied to clipboard
public final boolean getEnableVlm()
Indicates whether the ICR image pipeline should run late VLM augmentation.
Link copied to clipboard
public final VisionEngine getEngine()
Specifies which vision processing engine/pipeline to use for content extraction.
Link copied to clipboard
public final VlmProvider getFallbackProvider()
Optional secondary provider used to transparently retry a request when the primary fails in a way a retry on the same model can't fix — a content-filtered or refused response, or a transient outage (unreachable endpoint, server error, rate limit).
Link copied to clipboard
public final VisionFeatures getFeatures()
Vision features to enable during document processing.
Link copied to clipboard
public final VisionOutputFormat getOutputFormat()
Format of content returned by .
Link copied to clipboard
public final VlmProvider getProvider()
The primary Vision Language Model provider to use for AI-powered features.
Link copied to clipboard
public final void setAccessibleImageDescriptions(boolean value)
Indicates whether VLM image descriptions should be written as screen-reader alt text.
Link copied to clipboard
public final void setEnableOcr(OcrActivationMode value)
Controls OCR resource loading and OCR-based word detection inside the ICR image pipeline.
Link copied to clipboard
public final void setEnableVlm(boolean value)
Indicates whether the ICR image pipeline should run late VLM augmentation.
Link copied to clipboard
public final void setEngine(VisionEngine value)
Specifies which vision processing engine/pipeline to use for content extraction.
Link copied to clipboard
public final void setFallbackProvider(VlmProvider value)
Optional secondary provider used to transparently retry a request when the primary fails in a way a retry on the same model can't fix — a content-filtered or refused response, or a transient outage (unreachable endpoint, server error, rate limit).
Link copied to clipboard
public final void setFeatures(VisionFeatures value)
Vision features to enable during document processing.
Link copied to clipboard
public final void setOutputFormat(VisionOutputFormat value)
Format of content returned by .
Link copied to clipboard
public final void setProvider(VlmProvider value)
The primary Vision Language Model provider to use for AI-powered features.