Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Builder for crate::Client.

Explicit settings take precedence over environment variables, which take precedence over SDK defaults. Empty or whitespace-only environment values are ignored.

§Example

use typesafe_sdk::ClientBuilder;

let client = ClientBuilder::new("sk-...")
    .base_url("https://api.typesafe.ai")
    .default_model("jev-latest")
    .build()?;

Implementations§

Source§

impl ClientBuilder

Source

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

Create a builder with the given API key.

Use ClientBuilder::new when you have the key; use Client::from_env to read TYPESAFE_API_KEY from the environment.

Source

pub fn api_key(self, key: impl Into<String>) -> Self

Set the API key. Overrides the TYPESAFE_API_KEY environment variable.

Source

pub fn base_url(self, url: impl Into<String>) -> Self

Set the API root URL. Trailing slashes are stripped. Default: https://api.typesafe.ai.

Source

pub fn default_model(self, model: impl Into<String>) -> Self

Set the default model for requests that do not name one. Default: jev-latest.

Source

pub fn timeout(self, timeout: Duration) -> Self

Set the per-attempt timeout. Default: 10 seconds.

Source

pub fn retry(self, policy: RetryPolicy) -> Self

Set the retry policy. Default: RetryPolicy::default.

Source

pub fn header(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add a header sent with every request.

Authentication, Accept, Content-Type, and SDK identification headers are protected and cannot be overridden by user headers.

Source

pub fn http_client(self, client: Client) -> Self

Set a custom HTTP client.

The provided client is used as-is; its own timeout and TLS settings apply. The SDK adds per-attempt timeouts through the request context.

Source

pub fn log_level(self, level: LogLevel) -> Self

Set the log level. Falls back to TYPESAFE_LOG_LEVEL, then warn.

Source

pub fn build(self) -> Result<Client, Error>

Build the crate::Client.

Returns Error::Config when the API key is missing or configuration is invalid.

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> 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, 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