1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
//! Rust Client for interacting with the [Replicate API](https://replicate.com/docs/api/). Provides a type-safe interface by deserializing API responses into Rust structs.
//!
//! ### Getting Started
//!
//! Add `replicate_rust` to your `Cargo.toml` file.
//! ```toml
//! [dependencies]
//! replicate_rust = "0.0.3"
//! ```
//!
//! ## Example
//! In this example we will run a model that generates a caption for an image using the [Stable Diffusion](
//! https://replicate.ai/stability-ai/stable-diffusion) model.
//!
//! ```
//! use replicate_rust::{Replicate, config::Config};
//!
//! let config = Config::default();
//! let replicate = Replicate::new(config);
//!
//! // Creating 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),
//! }
//!
//! ```
use std::collections::HashMap;
use api_definitions::GetPrediction;
use collection::Collection;
use config::Config;
use model::Model;
use prediction::Prediction;
use training::Training;
pub mod collection;
pub mod config;
pub mod model;
pub mod prediction;
pub mod training;
pub mod version;
pub mod api_definitions;
pub mod prediction_client;
pub mod retry;
pub struct Replicate {
/// Holds a reference to a Config struct.
config: Config,
/// Holds a reference to a Prediction struct. Use to run inference given model inputs and version.
pub predictions: Prediction,
/// Holds a reference to a Model struct. Use to get information about a model.
pub models: Model,
/// Holds a reference to a Training struct. Use to create a new training run.
pub trainings: Training,
/// Holds a reference to a Collection struct. Use to get and list model collections present in Replicate.
pub collections: Collection,
}
/// Rust Client for interacting with the [Replicate API](https://replicate.com/docs/api/).
impl Replicate {
/// Create a new Replicate client.
///
/// # Example
/// ```
/// use replicate_rust::{Replicate, config::Config};
///
/// let config = Config::default();
/// let replicate = Replicate::new(config);
/// ```
pub fn new(config: Config) -> Self {
// Check if auth is set.
config.check_auth();
// TODO : Maybe reference instead of clone
let predictions = Prediction::new(config.clone());
let models = Model::new(config.clone());
let trainings = Training::new(config.clone());
let collections = Collection::new(config.clone());
Self {
config,
predictions,
models,
trainings,
collections,
}
}
/// Run a model with the given inputs in a blocking manner.
/// # Arguments
/// * `version` - The version of the model to run.
/// * `inputs` - The inputs to the model in the form of a HashMap.
/// # Example
/// ```
/// 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),
/// }
/// ```
/// # Errors
///
/// TODO : Add errors
///
pub fn run<K: serde::Serialize, V: serde::Serialize>(
&self,
version: String,
inputs: HashMap<K, V>,
// TODO : Perhaps not Box<dyn std::error::Error> but something more specific?
) -> Result<GetPrediction, Box<dyn std::error::Error>> {
let prediction = Prediction::new(self.config.clone()).create(version, inputs);
prediction.wait()
}
}
#[cfg(test)]
mod tests {
use super::*;
use httpmock::{
Method::{GET, POST},
MockServer,
};
use serde_json::json;
#[test]
fn test_run() -> Result<(), Box<dyn std::error::Error>> {
let server = MockServer::start();
// Mock the POST response
let post_mock = server.mock(|when, then| {
when.method(POST)
.path("/predictions")
.json_body_obj(&json!({
"version": "v1",
"input": {"text": "world"}
}));
then.status(200).json_body_obj(&json!({
"id": "p1",
"version": "v1",
"urls": {
"get": format!("{}/predictions/p1", server.base_url()),
"cancel": format!("{}/predictions/p1", server.base_url()),
},
"created_at": "2022-04-26T20:00:40.658234Z",
"completed_at": "2022-04-26T20:02:27.648305Z",
"source": "api",
"status": "processing",
"input": {"text": "world"},
"output": None::<String>,
"error": None::<String>,
"logs": None::<String>,
}));
});
// Mock the GET response
let get_mock = server.mock(|when, then| {
when.method(GET).path("/predictions/p1");
then.status(200).json_body_obj(&json!({
"id": "p1",
"version": "v1",
"urls": {
"get": format!("{}/predictions/p1", server.base_url()),
"cancel": format!("{}/predictions/p1", server.base_url()),
},
"created_at": "2022-04-26T20:00:40.658234Z",
"completed_at": "2022-04-26T20:02:27.648305Z",
"source": "api",
"status": "succeeded",
"input": {"text": "world"},
"output": "hello world",
"error": None::<String>,
"logs": "",
}));
});
let config = Config {
auth: String::from("test"),
base_url: server.base_url(),
..Config::default()
};
let replicate = Replicate::new(config);
let mut inputs = std::collections::HashMap::new();
inputs.insert("text", "world");
let version = String::from("test/model:v1");
let result = replicate.run(version, inputs).unwrap();
// Assert that the returned value is correct
assert_eq!(result.output, Some(serde_json::to_value("hello world")?));
// Ensure the mocks were called as expected
post_mock.assert();
get_mock.assert();
Ok(())
}
}