Struct Client 

pub struct Client { /* private fields */ }

Client for the TypeSafe System One API. Cheap to clone; shares one HTTP pool.

Implementations

impl Client

pub fn builder() -> ClientBuilder

Start configuring a client.

pub fn from_env() -> Result<Self>

Client configured entirely from TYPESAFE_API_KEY, TYPESAFE_DEFAULT_MODEL and TYPESAFE_BASE_URL.

Errors

Same as ClientBuilder::build; in practice a missing TYPESAFE_API_KEY.

pub fn default_model(&self) -> &str

The model used when Client::system_one is called.

pub fn system_one(&self) -> SystemOneRequest<'_>

Start building a POST /v1/systemone call: state, questions, then .send().

pub async fn evaluate<K>( &self, state: impl Serialize, questions: impl IntoIterator<Item = (K, Question)>, ) -> Result<SystemOneResponse>

where K: Into<String>,

Evaluate state against an existing map of questions with the client’s default model. The builder form is Client::system_one.

Questions are keyed by the ids you choose; answers come back under the same ids. All questions see the same state and are evaluated independently.

Errors

Error::RequestSerialization if state cannot be serialised; an HTTP-status variant (Error::Authentication, Error::UnprocessableEntity, Error::RateLimit, …) for a non-2xx answer after retries; Error::Connection / Error::Timeout for transport failures; Error::ResponseValidation if the body is not the documented shape.

pub async fn evaluate_with_model<K>( &self, model: &str, state: impl Serialize, questions: impl IntoIterator<Item = (K, Question)>, ) -> Result<SystemOneResponse>

where K: Into<String>,

Client::evaluate with an explicit model.

Errors

As Client::evaluate.

pub async fn models(&self) -> Result<Vec<ModelInfo>>

List the model names and aliases this account may send in the model field.

Errors

An HTTP-status variant for a non-2xx answer after retries, Error::Connection / Error::Timeout for transport failures, Error::ResponseValidation for an unexpected body.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.