Skip to main content

UreqClient

Struct UreqClient 

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

Blocking TypeSafe client backed by ureq.

use typesafe_ai::{Question, Request, UreqClient};

let client = UreqClient::new(std::env::var("TYPESAFE_API_KEY")?)?;
let request = Request::new("Please refund duplicate charge 1042.")
    .with_question("is_billing", Question::noul("Is this a billing request?"));
let response = client.evaluate(&request)?;

Implementations§

Source§

impl UreqClient

Source

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

Creates a client with ClientConfig::default.

The API key is marked sensitive and omitted from the client’s debug output.

Source

pub fn with_config( api_key: impl Into<String>, config: ClientConfig, ) -> Result<Self, UreqError>

Creates a client with explicit shared configuration.

Source

pub fn with_agent( api_key: impl Into<String>, config: ClientConfig, agent: Agent, ) -> Result<Self, UreqError>

Creates a client around an existing ureq agent.

Custom transport and resolver behavior from the agent is preserved. TypeSafe’s status, redirect, and timeout policies are applied to each request.

Source

pub fn evaluate(&self, request: &Request) -> Result<Response, UreqError>

Evaluates every question in request against its shared state.

The request is validated before any HTTP exchange. HTTP 429 and 529 responses are retried according to ClientConfig::max_retries.

Source

pub fn evaluate_events( &self, request: &Request, ) -> impl Iterator<Item = EvaluationEvent<Error>>

Creates a lazy iterator over attempt failures and the terminal result.

Construction performs no validation, waiting, or HTTP work. Each call to next drives at most one HTTP attempt and yields failures before any retry delay. See SyncClient::evaluate_events for retry timing and interruption behavior.

use typesafe_ai::{UreqClient, Request};

for event in client.evaluate_events(request) {
    println!("{event:?}");
}

Trait Implementations§

Source§

impl Clone for UreqClient

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 UreqClient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl SyncClient for UreqClient

Source§

type TransportError = Error

The concrete transport error produced by this implementation.
Source§

fn evaluate_events( &self, request: &Request, ) -> impl Iterator<Item = EvaluationEvent<Self::TransportError>>

Creates a lazy iterator of attempt failures and the final evaluation result. Read more
Source§

fn evaluate( &self, request: &Request, ) -> Result<Response, Error<Self::TransportError>>

Drives the event iterator to its terminal result.

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