This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/csharp/settings/vision/advanced/open-ai-api-endpoint-settings.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. OpenAIApiEndpointSettings

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

ApiEndpoint

public string ApiEndpoint { get; set; }

API endpoint URL for OpenAI-compatible chat completions

Type: string

ApiKey

public string ApiKey { get; set; }

OpenAI API key for authentication.

Type: string

BatchSize

public int BatchSize { get; set; }

Number of zone images to include per VLM API call.

Type: int

ClassificationStrategy

public VlmClassificationStrategy ClassificationStrategy { get; set; }

Strategy for how zones are sent to the VLM for classification.

Type: VlmClassificationStrategy

FastMode

public bool FastMode { get; set; }

Whether OpenAI requests use Fast mode for lower latency at premium token pricing. Fast mode is available only for supported models and request types.

Type: bool

MaxConcurrency

public int MaxConcurrency { get; set; }

Maximum number of concurrent VLM API calls.

Type: int

MaxTokens

public int MaxTokens { get; set; }

Maximum tokens in response (-1 = unlimited)

Type: int

Model

public string Model { get; set; }

Model identifier to use for classification

Type: string

SendFullPageReference

public bool SendFullPageReference { get; set; }

Whether to send the full page image as reference context alongside cropped zones. Only used when UseZoneCropping is true.

Type: bool

Stream

public bool Stream { get; set; }

Whether to stream responses from the API

Type: bool

SystemPrompt

public string SystemPrompt { get; set; }

Optional custom system prompt for zone classification. When empty, the module uses a default prompt based on the ClassificationStrategy.

Type: string

Temperature

public double Temperature { get; set; }

Temperature for response generation (0.0 = deterministic, 1.0 = creative). Defaults to 0.0 because zone classification and verbatim text extraction are deterministic tasks — randomness only adds run-to-run noise.

Type: double

Resource management

public void Dispose()

OpenAIApiEndpointSettings 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.