OpenAILanguagesDetectionSettings

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

from nutrient_sdk import OpenAILanguagesDetectionSettings

Construction

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

# SDK-wide default (applies to all documents)
SdkSettings.open_ai_languages_detection_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.open_ai_languages_detection_settings = other_settings is rejected.

Properties

api_endpoint

@property
def api_endpoint(self) -> str

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

OpenAI API endpoint URL.

Type: str

Default: "https://api.openai.com/v1"

api_key

@property
def api_key(self) -> str

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

OpenAI API key for authentication.

Type: str

Default: string.Empty

detail

@property
def detail(self) -> str

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

Detail level for image analysis (low, high, auto).

Type: str

Default: "low"

max_tokens

@property
def max_tokens(self) -> int

@max_tokens.setter
def max_tokens(self, value: int) -> None

Maximum number of tokens in the response.

Type: int

Default: 500

model

@property
def model(self) -> str

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

Model to use for language detection (e.g., “gpt-4o-mini”).

Type: str

Default: "gpt-4o-mini"

temperature

@property
def temperature(self) -> float

@temperature.setter
def temperature(self, value: float) -> None

Temperature for response generation (0.0 to 1.0). Lower values produce more deterministic outputs.

Type: float

Default: 0.0