FormVlmFallbackConnectionSettings

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

Tags: Vision, Advanced

from nutrient_sdk import FormVlmFallbackConnectionSettings

Construction

# Per-document override
with Document.open("input.pdf") as doc:
    settings = doc.settings.form_vlm_fallback_connection_settings
    settings.some_field = new_value          # mutate fields directly

# SDK-wide default (applies to all documents)
SdkSettings.form_vlm_fallback_connection_settings.some_field = new_value

Settings are configured by writing to fields on the returned object. The settings property itself cannot be reassigned — doc.settings.form_vlm_fallback_connection_settings = other_settings is rejected.

Properties

api_endpoint

@property
def api_endpoint(self) -> str

@api_endpoint.setter
def api_endpoint(self, value: str) -> None

API endpoint URL for the fallback form-field model’s OpenAI-compatible chat completions route. Empty (the default) until an operator configures it.

Type: str

Default: string.Empty

api_key

@property
def api_key(self) -> str

@api_key.setter
def api_key(self, value: str) -> None

API key for authentication with the fallback form-field model service.

Type: str

Default: string.Empty

model

@property
def model(self) -> str

@model.setter
def model(self, value: str) -> None

Model identifier to request at the configured fallback endpoint.

Type: str

Default: "form-field-vlm"