Struct Client 

pub struct Client { /* private fields */ }

Available on crate feature http only.

A TypeSafe API client. Cheap to clone; clones share one connection pool.

Implementations

impl Client

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

A client with api_key; base URL and default model come from the environment or the defaults.

pub fn from_env() -> Result<Self, Error>

A client configured entirely from the environment (see API_KEY_ENV).

pub fn builder() -> ClientBuilder

A builder for configuring the client.

pub fn base_url(&self) -> &str

The base URL requests are sent to.

pub fn default_model(&self) -> &str

The model used when a request does not name one.

pub fn system_one( &self, state: impl Into<Content>, questions: Questions, ) -> SystemOneCall<Self>

Starts a call that asks questions about state. The call owns a clone of the client, so it can be spawned or stored:

use typesafe_client::{Client, NoulQuestion, Questions};

let client = Client::from_env()?;
let mut questions = Questions::new();
let urgent = questions.add("is_urgent", NoulQuestion::new("Does this convey urgency?"));

let call = client
    .system_one("Payouts failing for 3 days!", questions)
    .model("jev-latest")
    .timeout(std::time::Duration::from_secs(5));
let response = tokio::spawn(call.send()).await.expect("task ran")?;
println!("urgent: {:.2}", response.answer(&urgent)?.noul);

pub async fn evaluate( &self, request: &SystemOneRequest, ) -> Result<SystemOneResponse, Error>

Sends a prepared request with the client’s default timeout and retry policy. Send the same request repeatedly, changing only request.state, to reuse questions without cloning them.

pub async fn list_models(&self) -> Result<ModelList, Error>

Lists the models available to the account.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.

impl SystemOne for Client

fn send<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, request: &'life1 SystemOneRequest, options: &'life2 CallOptions, ) -> Pin<Box<dyn Future<Output = Result<SystemOneResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Sends request, using the transport’s default model when request.model is None.

fn list_models<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ModelList, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists the models available to the account.

fn system_one( &self, state: impl Into<Content>, questions: Questions, ) -> SystemOneCall<Self>

where Self: Sized + Clone,

Starts a call that asks questions about state.