TypeSafeClient

Namespace: TypeSafe.AI.Sdk

public sealed class TypeSafeClient : ITypeSafeClient, IDisposable

Client for the TypeSafe AI API. Community .NET port of @typesafe-ai/sdk.

Inheritance: object

Implements: ITypeSafeClient, IDisposable

View source

Constructors

TypeSafeClient(HttpClient, TypeSafeClientOptions?)

public TypeSafeClient(HttpClient httpClient, TypeSafeClientOptions? options = null)

Create a client that uses the given HttpClient (typically from IHttpClientFactory).

Parameters

Name	Type	Description
httpClient	HttpClient
options	TypeSafeClientOptions

View source

TypeSafeClient(string, HttpClient, TypeSafeClientOptions?)

public TypeSafeClient(string apiKey, HttpClient httpClient, TypeSafeClientOptions? options = null)

Create a client with an explicit API key and HttpClient.

Parameters

Name	Type	Description
apiKey	string
httpClient	HttpClient
options	TypeSafeClientOptions

View source

TypeSafeClient(string, TypeSafeClientOptions?)

public TypeSafeClient(string apiKey, TypeSafeClientOptions? options = null)

Create a client with an explicit API key.

Parameters

Name	Type	Description
apiKey	string
options	TypeSafeClientOptions

View source

TypeSafeClient(TypeSafeClientOptions?)

public TypeSafeClient(TypeSafeClientOptions? options = null)

Create a client. Explicit options take precedence over environment variables, then SDK defaults. Empty or whitespace-only environment values are ignored.

Parameters

Name	Type	Description
options	TypeSafeClientOptions

Exceptions

Type	Condition
TypeSafeException	The API key is missing or configuration is invalid.

View source

Fields

DefaultBaseUrl

public const string DefaultBaseUrl = "https://api.typesafe.ai"

API root used when neither config nor TYPESAFE_BASE_URL is set.

Value: string

View source

DefaultModelName

public const string DefaultModelName = "jev-latest"

Model used when a request omits model.

Value: string

View source

HttpClientName

public const string HttpClientName = "TypeSafe.AI"

Named HttpClient used with IHttpClientFactory.

Value: string

View source

Properties

BaseUrl

public string BaseUrl { get; }

API root with trailing slashes removed.

Value: string

View source

Compression

public bool Compression { get; }

Whether request bodies of 1 KiB or more are compressed with zstd.

Value: bool

View source

DefaultHeaders

public IReadOnlyDictionary<string, string> DefaultHeaders { get; }

Additional headers sent with each request.

Value: IReadOnlyDictionary<string, string>

View source

DefaultModel

public string DefaultModel { get; }

Model used when a request omits model.

Value: string

View source

LogLevel

public TypeSafeLogLevel LogLevel { get; }

Configured log verbosity.

Value: TypeSafeLogLevel

View source

Logger

public ITypeSafeLogger Logger { get; }

The configured logger, filtered to LogLevel.

Value: ITypeSafeLogger

View source

Models

public ModelsResource Models { get; }

The models available to the account.

Value: ModelsResource

View source

Retry

public RetryPolicy Retry { get; }

Retry settings with constructor overrides applied.

Value: RetryPolicy

View source

TimeoutMs

public int TimeoutMs { get; }

Timeout per attempt in milliseconds.

Value: int

View source

Methods

Dispose()

public void Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

View source

SystemOneAsync(object?, IDictionary<string, Question>, string?, RequestOptions?, CancellationToken)

public Task<SystemOneResult> SystemOneAsync(object? state, IDictionary<string, Question> questions, string? model = null, RequestOptions? options = null, CancellationToken cancellationToken = default)

Answer named questions about text or structured state.

Parameters

Name	Type	Description
state	object
questions	IDictionary<string, Question>
model	string
options	RequestOptions
cancellationToken	CancellationToken

Returns: Task<SystemOneResult>

View source

SystemOneAsync(object?, params (string Name, Question Question)[])

public Task<SystemOneResult> SystemOneAsync(object? state, params (string Name, Question Question)[] questions)

Answer named questions about text or structured state. Duplicate names throw. Use the dictionary overload for model, options, or a cancellation token.

Parameters

Name	Type	Description
state	object
questions	(string Name, Question Question)[]

Returns: Task<SystemOneResult>

View source

SystemOneAsync(SystemOneRequest, RequestOptions?, CancellationToken)

public Task<SystemOneResult> SystemOneAsync(SystemOneRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Answer named questions about text or structured state.

Parameters

Name	Type	Description
request	SystemOneRequest
options	RequestOptions
cancellationToken	CancellationToken

Returns: Task<SystemOneResult>

View source

SystemOneWithResponseAsync(object?, IDictionary<string, Question>, string?, RequestOptions?, CancellationToken)

public Task<TypeSafeResponse<SystemOneResult>> SystemOneWithResponseAsync(object? state, IDictionary<string, Question> questions, string? model = null, RequestOptions? options = null, CancellationToken cancellationToken = default)

Answer named questions and return the HTTP response metadata.

Parameters

Name	Type	Description
state	object
questions	IDictionary<string, Question>
model	string
options	RequestOptions
cancellationToken	CancellationToken

Returns: Task<TypeSafeResponse<SystemOneResult>>

View source

SystemOneWithResponseAsync(object?, params (string Name, Question Question)[])

public Task<TypeSafeResponse<SystemOneResult>> SystemOneWithResponseAsync(object? state, params (string Name, Question Question)[] questions)

Answer named questions and return the HTTP response metadata. Duplicate names throw. Use the dictionary overload for model, options, or a cancellation token.

Parameters

Name	Type	Description
state	object
questions	(string Name, Question Question)[]

Returns: Task<TypeSafeResponse<SystemOneResult>>

View source

SystemOneWithResponseAsync(SystemOneRequest, RequestOptions?, CancellationToken)

public Task<TypeSafeResponse<SystemOneResult>> SystemOneWithResponseAsync(SystemOneRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Answer named questions and return the HTTP response metadata.

Parameters

Name	Type	Description
request	SystemOneRequest
options	RequestOptions
cancellationToken	CancellationToken

Returns: Task<TypeSafeResponse<SystemOneResult>>

View source