Documentation
Table of Contents

Class IntentClientOptions

Namespace
IntentSharp
Assembly
IntentSharp.dll

Client-wide settings. Set once when building the IntentClient.

public sealed class IntentClientOptions
Inheritance
object
IntentClientOptions
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()
Extension Methods

Constructors

IntentClientOptions()

Creates options with the default on each property.

Properties

CacheTtl

Time-to-live for cached responses.

DefaultTimeout

Default per-request wall-clock budget. Null means no budget beyond provider timeouts; a value must be greater than zero.

FailWhenUnlicensed

When true, building the client throws LicenseException if no key is configured, the key is invalid, or the evaluation has ended, instead of only logging. For teams that want a hard stop in their own builds and deployments. Default false.

FallbackOnTransientErrors

Fall back to the secondary provider when the primary fails with a transient error (HTTP 429, 5xx, transport) or an HTTP timeout. Authentication, validation and other non-transient errors never fall back.

JudgeMode

When the judge reviews results. Default OnRequest: only for requests that set UseJudge.

JudgeModel

Model used for judge calls. Null uses the provider default.

LicenseKey

Commercial or evaluation license key. When it is null or blank, building the client reads the key from the INTENTSHARP_LICENSE_KEY environment variable instead; a key set here, in code or in configuration, wins. Each client checks its key offline, once, when it is built; there is no process-wide state. A current paid or evaluation key logs one information line at build. No key, an invalid key, an ended evaluation and an ended paid term all leave the client working: the client logs a warning or an error at build and repeats it at most once per LicenseReminderInterval while the client is used, moving a long-running client from licensed to renewal-due to lapsed as the dates pass. The only key that stops the client is a paid key whose maintenance period ended before this build was released: building throws LicenseException. An evaluation key never stops the client this way. Set FailWhenUnlicensed to also stop on a missing or invalid key or an ended evaluation. Leave the key empty only for the free use the license allows, summarized in FreeUseSummary.

LicenseReminderInterval

Minimum time between repeated license notices while the client is used. Default one hour; must be greater than zero.

MaxAttempts

Default attempts per request. Attempt 2 and later send the problems found in the earlier reply back to the model.

MaxInputChars

Hard limit on serialized input size sent to the model, in characters. Larger inputs are rejected, never silently truncated.

MaxModelCalls

Default ceiling on model calls per request (attempts plus judge calls).

MaxOutputTokens

Default output token ceiling per model call.

RecordInMemory

Record every completed request in the configured memory.

Temperature

Default sampling temperature sent to providers that accept it. Null sends none.

UseCache

Serve identical requests from the request cache when one is configured.