Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

An async client for the TypeSafe System One API.

Construct with Client::builder or Client::from_env. The client is Clone and cheap to clone (an Arc inside), and Send + Sync.

Every method is async; there is no blocking client. Cancellation is dropping the returned future.

let client = Client::builder()
    .api_key("sk-live-...")
    .default_header("X-Agent-Client", "my-app")
    .build()?;

Implementations§

Source§

impl Client

Source

pub fn builder() -> ClientBuilder

Creates a builder.

Source

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

Creates a client from TYPESAFE_API_KEY (and the other TYPESAFE_* variables), exactly like Client::builder().build().

Source

pub fn base_url(&self) -> &str

The configured base URL.

Source

pub fn default_model(&self) -> &str

The configured default model.

Source

pub fn timeout(&self) -> Duration

The configured per-attempt timeout.

Source

pub fn retry_policy(&self) -> &RetryPolicy

The configured default retry policy.

Source

pub fn log_level(&self) -> LogLevel

The configured log level.

Source

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

Answers the questions in request about its state.

Client-side validation runs before any network I/O; failures return Error::InvalidRequest. Retries, per the client’s default policy, are automatic.

Source

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

Answers the questions in request with per-call options.

A per-call retry policy fully replaces the client’s policy for this call.

Source

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

Lists the models and aliases available to the authenticated account.

Source

pub async fn list_models_with( &self, options: RequestOptions, ) -> Result<Vec<ModelMetadata>, Error>

Lists the models with per-call options.

A per-call retry policy fully replaces the client’s policy for this call. extra_body has no effect here (the request has no body).

Trait Implementations§

Source§

impl Clone for Client

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 Client

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