Skip to main content

TypeSafeClient

Struct TypeSafeClient 

Source
#[non_exhaustive]
pub struct TypeSafeClient { /* private fields */ }
Expand description

Client for the TypeSafe AI API.

Construct with TypeSafeClient::new or TypeSafeClient::from_env. Cloning is cheap and shares the underlying connection pool.

Implementations§

Source§

impl TypeSafeClient

Source

pub fn new(api_key: impl Into<String>) -> Result<Self>

Create a new client with the given API key and default settings.

Source

pub fn from_config(config: ClientConfig) -> Result<Self>

Create a new client from a full ClientConfig.

Source

pub fn from_env() -> Result<Self>

Create a new client, reading the API key from the TYPESAFE_API_KEY environment variable. Also reads TYPESAFE_BASE_URL and TYPESAFE_DEFAULT_MODEL if set.

Source

pub fn base_url(&self) -> &str

Returns the base URL this client is configured to use.

Source

pub fn default_model(&self) -> &str

Returns the default model this client uses.

Source

pub async fn system_one( &self, state: impl Into<Value>, questions: HashMap<String, Question>, ) -> Result<SystemOneResponse>

Answer named questions about text or structured state.

Sends a POST /v1/systemone request and returns a typed SystemOneResponse.

§Arguments
  • state — text, a JSON object, or an array to evaluate. Accepts &str, String, or any serde_json::Value.
  • questions — a non-empty map of question names to Questions.

Use system_one_with_model to override the client’s default model.

§Retry safety

This is a POST request. The SDK automatically retries on transient failures (408, 429, 500, 502, 503, 504, 529, connection errors, timeouts), but a timeout does not guarantee the server did not process the request. If the endpoint has side effects (credit consumption, usage recording, downstream triggers), a retry may result in duplicate processing. Future versions will support an Idempotency-Key header to make retries safe.

To avoid replaying a POST whose body the server already processed, errors that occur while reading the response body — including timeouts and truncated bodies — are classified as non-retryable ErrorKind::Transport rather than ErrorKind::Connection or ErrorKind::Timeout.

§Errors
Source

pub async fn system_one_with_model( &self, state: impl Into<Value>, questions: HashMap<String, Question>, model: Option<&str>, ) -> Result<SystemOneResponse>

Like system_one but with an explicit model override (None uses the client default).

Source

pub async fn system_one_with_opts( &self, questions: HashMap<String, Question>, opts: SystemOneOpts, ) -> Result<SystemOneResponse>

Like system_one but with full per-call options via a SystemOneOpts builder.

This allows overriding the model, adding extra body fields for forward compatibility, and attaching custom headers — all per-call.

§Example
use typesafeai_sdk::{TypeSafeClient, noul, SystemOneOpts};
use std::collections::HashMap;

let client = TypeSafeClient::from_env()?;
let mut questions = HashMap::new();
questions.insert("billing".to_string(), noul("Is this about billing?").into());

let opts = SystemOneOpts::new()
    .with_model(Some("jev-latest".to_string()))
    .with_extra_body(serde_json::json!({"user_id": "u123"}));

let response = client.system_one_with_opts(questions, opts).await?;
Source

pub async fn list_models(&self) -> Result<ListModelsResponse>

List available models. Sends GET /v1/models.

Trait Implementations§

Source§

impl Clone for TypeSafeClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TypeSafeClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more