Replicate Rust client

An Unofficial Rust client for Replicate

[![Documentation]][docs.rs] [![Latest Version]][crates.io] [](https://github.com/Shubhamai/replicate-rust/actions/workflows/tests.yml) [](https://github.com/rust-lang/rust/blob/master/RELEASES.md#version-1720-2023-08-24)

Documentation · Crate · Report Bug · Request Feature

An Unofficial Rust client for Replicate. Provides a type-safe interface by deserializing API responses into Rust structs.

Getting Started

Add replicate_rust to Cargo.toml:

toml [dependencies] replicate-rust = "0.0.3"

Grab your token from replicate.com/account and set it as an environment variable:

sh export REPLICATE_API_TOKEN=<your token>

Here's an example using replicate_rust to run a model.

```rust use~ replicate_rust::{Replicate, config::Config};

let config = Config::default(); let replicate = Replicate::new(config);

// Construct the inputs. let mut inputs = std::collections::HashMap::new(); inputs.insert("prompt", "a 19th century portrait of a wombat gentleman");

let version = String::from("stability-ai/stable-diffusion:27b93a2413e7f36cd83da926f3656280b2931564ff050bf9575f1fdf9bcd7478");

// Run the model. let result = replicate.run(version, inputs);

// Print the result. match result { Ok(result) => println!("Success : {:?}", result.output), Err(e) => println!("Error : {}", e), } // Some(Array [String("https://pbxt.replicate.delivery/QLDGe2rXuIQ9ByMViQEXrYCkKfDi9I3YWAzPwWsDZWMXeN7iA/out-0.png")])

Usage

See the reference docs for detailed API documentation.

Examples

Run a model in the background

You can start a model and run it in the background:

```rust let config = Config::default(); let replicate = Replicate::new(config);

// Construct the inputs. let mut inputs = std::collections::HashMap::new(); inputs.insert("prompt", "a 19th century portrait of a wombat gentleman");

let version = String::from("stability-ai/stable-diffusion:27b93a2413e7f36cd83da926f3656280b2931564ff050bf9575f1fdf9bcd7478");

// Run the model. let mut prediction = replicate.predictions.create(version, inputs);

println!("{}", prediction.status) // 'starting'

prediction.reload() println!("{}", prediction.status) // 'processing'

println!("{}", prediction.logs) // Some("Using seed: 3599 // 0%| | 0/50 [00:00

prediction.wait()

println!("{}", prediction.status) // 'succeeded'

match prediction.wait() { Ok(result) => println!("Success : {:?}", result.output), Err(e) => println!("Error : {}", e), } // Success : Some(Array [String("https://pbxt.replicate.delivery/QLDGe2rXuIQ9ByMViQEXrYCkKfDi9I3YWAzPwWsDZWMXeN7iA/out-0.png")]) ```

Cancel a prediction

You can cancel a running prediction:

```rust

let config = Config::default(); let replicate = Replicate::new(config);

// Construct the inputs. let mut inputs = std::collections::HashMap::new(); inputs.insert("prompt", "a 19th century portrait of a wombat gentleman");

let version = String::from("stability-ai/stable-diffusion:27b93a2413e7f36cd83da926f3656280b2931564ff050bf9575f1fdf9bcd7478");

// Run the model. let mut prediction = replicate.predictions.create(version, inputs);

println!("{}", prediction.status) // 'starting'

prediction.cancel()

prediction.reload()

println!("{}", prediction.status) // 'cancelled' ```

List predictions

You can list all the predictions you've run:

rust match replicate.predictions.list() { Ok(result) => println!("Success : {:?}", result), Err(e) => println!("Error : {}", e), } // Success : ListPredictions { ... }

Get model Information

```rust match replicate.models.get(String::from("replicate"), String::from("hello-world")) { Ok(result) => println!("Success : {:?}", result), Err(e) => println!("Error : {}", e), };

// Success : GetModel { ... } ```

Get Versions List

```rust match replicate .models .versions .list(String::from("replicate"), String::from("hello-world")) { Ok(result) => println!("Success : {:?}", result), Err(e) => println!("Error : {}", e), }; // Success : ListModelVersions { ... } ``````

Get Model Version Information

rust match replicate.models.versions.get( String::from("kvfrans"), String::from("clipdraw"), String::from("5797a99edc939ea0e9242d5e8c9cb3bc7d125b1eac21bda852e5cb79ede2cd9b"), ) { Ok(result) => println!("Success : {:?}", result), Err(e) => println!("Error : {}", e), } // Success : GetModelVersion { ... }

Get Collection Information

```rust match replicate.collections.get(String::from("audio-generation")) { Ok(result) => println!("Success : {:?}", result), Err(e) => println!("Error : {}", e), }

// Success : GetCollectionModels { ... } ```

Get Collection Lists

```rust match replicate.collections.list() { Ok(result) => println!("Success : {:?}", result), Err(e) => println!("Error : {}", e), }

// Success : ListCollectionModels { ... } ```