Client

Struct Client 

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

Main client for interacting with the Replicate API.

Implementations§

Source§

impl Client

Source

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

Create a new client with the given API token.

Source

pub fn from_env() -> Result<Self>

Create a new client using the API token from the environment.

Looks for the token in the REPLICATE_API_TOKEN environment variable.

Source

pub fn with_base_url( api_token: impl Into<String>, base_url: impl Into<String>, ) -> Result<Self>

Create a new client with custom base URL.

Source

pub fn predictions(&self) -> &PredictionsApi

Get access to the predictions API.

Source

pub fn files(&self) -> &FilesApi

Get access to the files API.

Source

pub fn create_prediction(&self, version: impl Into<String>) -> PredictionBuilder

Create a new prediction with a fluent builder API.

§Examples
let client = Client::new("your-api-token")?;

let prediction = client
    .create_prediction("stability-ai/sdxl:version-id")
    .input("prompt", "A futuristic city skyline")
    .input("width", 1024)
    .input("height", 1024)
    .send()
    .await?;

println!("Prediction ID: {}", prediction.id);
Source

pub fn run(&self, version: impl Into<String>) -> PredictionBuilder

Run a model and wait for completion (convenience method).

This is equivalent to creating a prediction and waiting for it to complete.

§Examples
let client = Client::new("your-api-token")?;

let result = client
    .run("stability-ai/sdxl:version-id")
    .input("prompt", "A futuristic city skyline")
    .send_and_wait()
    .await?;

println!("Result: {:?}", result.output);
Source

pub fn http_client(&self) -> &HttpClient

Get the underlying HTTP client.

Source

pub fn http_client_mut(&mut self) -> &mut HttpClient

Get mutable access to the underlying HTTP client.

This allows configuring retry settings after client creation.

Source

pub fn configure_retries( &mut self, max_retries: u32, min_delay: Duration, max_delay: Duration, ) -> Result<()>

Configure retry settings for this client.

This is a convenience method that delegates to the HTTP client.

§Examples
let mut client = Client::new("your-api-token")?;

// Configure more aggressive retry settings
client.configure_retries(
    5,                               // max_retries
    Duration::from_millis(100),      // min_delay
    Duration::from_secs(60),         // max_delay
)?;
Source

pub fn configure_timeouts( &mut self, connect_timeout: Option<Duration>, request_timeout: Option<Duration>, ) -> Result<()>

Configure timeout settings for this client.

This is a convenience method that delegates to the HTTP client.

§Examples
let mut client = Client::new("your-api-token")?;

// Configure custom timeouts
client.configure_timeouts(
    Some(Duration::from_secs(10)),   // connect_timeout
    Some(Duration::from_secs(120)),  // request_timeout
)?;
Source

pub fn with_http_config( api_token: impl Into<String>, http_config: HttpConfig, ) -> Result<Self>

Create a new client with custom HTTP configuration.

Source

pub fn timeout_config(&self) -> &TimeoutConfig

Get the current timeout configuration.

Source

pub fn http_config(&self) -> &HttpConfig

Get the current HTTP configuration.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · 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§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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: 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: 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,