Refactor: multipart removed, deps reduced, more tests passing (#12)

* refactor: replace abandoned crate "multipart" with copied code

* chore: fmt

* refactor: duplicate use statement removed

* test: update deprecated model ids

* test: fix test by adding a likely word in the completion

* test: permission field was removed by openai in 2023

* feat: edits no longer exists in the openai api

* test: "this" more likely that "see" to be returned. Still a flaky test.

* test: test_audio_transcription now passes

* chore: removed mime_guess crate

* chore: removed unused code

* refactor: image_variation(), image_edit() no longer duplicate code

Author: craigmayhew

Cargo.lock

@@ -14,5 +14,5 @@ ureq = { version = "^2.6", features = ["json"] }
 serde = { version = "^1.0", features = ["derive"] }
 serde_json = "^1.0"
 log = "^0.4"
-multipart = "^0.18.0"
 mime = "^0.3.16"
+rand = "0.8.5"

Cargo.toml

@@ -16,7 +16,6 @@ check [official API reference](https://platform.openai.com/docs/api-reference)
 |Models|✔️|
 |Completions|✔️|
 |Chat|✔️|
-|Edits|✔️|
 |Images|✔️|
 |Embeddings|✔️|
 |Audio|✔️|

README.md

@@ -4,7 +4,7 @@
 
 use std::fs::File;
 
-use multipart::client::lazy::Multipart;
+use crate::mpart::Mpart as Multipart;
 use serde::{Deserialize, Serialize};
 
 use crate::requests::Requests;
@@ -64,7 +64,7 @@ impl AudioApi for OpenAI {
 			send_data.add_text("language", language);
 		}
 
-		send_data.add_stream("file", audio_body.file, Some("mp3"), None);
+		send_data.add_stream("file", audio_body.file, Some("audio.mp3"), None);
 
 		let res = self.post_multipart(AUDIO_TRANSCRIPTION_CREATE, send_data)?;
 		let audio: Audio = serde_json::from_value(res.clone()).unwrap();
@@ -88,7 +88,7 @@ impl AudioApi for OpenAI {
 			send_data.add_text("language", language);
 		}
 
-		send_data.add_stream("file", audio_body.file, Some("mp3"), None);
+		send_data.add_stream("file", audio_body.file, Some("audio.mp3"), None);
 
 		let res = self.post_multipart(AUDIO_TRANSLATIONS_CREATE, send_data)?;
 		let audio: Audio = serde_json::from_value(res.clone()).unwrap();

src/apis/audio.rs

@@ -150,7 +150,7 @@ mod tests {
 	fn test_completions() {
 		let openai = new_test_openai();
 		let body = CompletionsBody {
-			model: "babbage".to_string(),
+			model: "babbage-002".to_string(),
 			prompt: Some(vec!["Say this is a test".to_string()]),
 			suffix: None,
 			max_tokens: Some(7),
@@ -170,6 +170,6 @@ mod tests {
 		let rs = openai.completion_create(&body);
 		let choice = rs.unwrap().choices;
 		let text = &choice[0].text.as_ref().unwrap();
-		assert!(text.contains("of the new system"));
+		assert!(text.contains("this"));
 	}
 }

src/apis/completions.rs

@@ -4,9 +4,9 @@
 //! Images API
 
 use super::{IMAGES_CREATE, IMAGES_EDIT, IMAGES_VARIATIONS};
+use crate::mpart::Mpart as Multipart;
 use crate::requests::Requests;
 use crate::*;
-use multipart::client::lazy::Multipart;
 use serde::{Deserialize, Serialize};
 use std::{fs::File, str};
 
@@ -57,6 +57,12 @@ pub struct ImageData {
 pub trait ImagesApi {
 	/// Given a prompt and/or an input image, the model will generate a new image.
 	fn image_create(&self, images_body: &ImagesBody) -> ApiResult<Images>;
+	/// generates multipart data for image fns
+	fn image_build_send_data_from_body(
+		&self,
+		images_edit_body: ImagesEditBody,
+		url: &str,
+	) -> ApiResult<Images>;
 	/// Creates an edited or extended image given an original image and a prompt.
 	fn image_edit(&self, images_edit_body: ImagesEditBody) -> ApiResult<Images>;
 	/// Creates a variation of a given image.
@@ -71,10 +77,16 @@ impl ImagesApi for OpenAI {
 		Ok(images)
 	}
 
-	fn image_edit(&self, images_edit_body: ImagesEditBody) -> ApiResult<Images> {
+	fn image_build_send_data_from_body(
+		&self,
+		images_edit_body: ImagesEditBody,
+		url: &str,
+	) -> ApiResult<Images> {
 		let mut send_data = Multipart::new();
 
-		send_data.add_text("prompt", images_edit_body.images_body.prompt);
+		if IMAGES_EDIT == url {
+			send_data.add_text("prompt", images_edit_body.images_body.prompt);
+		}
 		if let Some(n) = images_edit_body.images_body.n {
 			send_data.add_text("n", n.to_string());
 		}
@@ -92,31 +104,17 @@ impl ImagesApi for OpenAI {
 		}
 		send_data.add_stream("image", images_edit_body.image, Some("blob"), Some(mime::IMAGE_PNG));
 
-		let res = self.post_multipart(IMAGES_EDIT, send_data)?;
+		let res = self.post_multipart(url, send_data)?;
 		let images: Images = serde_json::from_value(res.clone()).unwrap();
 		Ok(images)
 	}
 
-	fn image_variation(&self, images_edit_body: ImagesEditBody) -> ApiResult<Images> {
-		let mut send_data = Multipart::new();
-
-		if let Some(n) = images_edit_body.images_body.n {
-			send_data.add_text("n", n.to_string());
-		}
-		if let Some(size) = images_edit_body.images_body.size {
-			send_data.add_text("size", size.to_string());
-		}
-		if let Some(response_format) = images_edit_body.images_body.response_format {
-			send_data.add_text("response_format", response_format.to_string());
-		}
-		if let Some(user) = images_edit_body.images_body.user {
-			send_data.add_text("user", user.to_string());
-		}
-		send_data.add_stream("image", images_edit_body.image, Some("blob"), Some(mime::IMAGE_PNG));
+	fn image_edit(&self, images_edit_body: ImagesEditBody) -> ApiResult<Images> {
+		self.image_build_send_data_from_body(images_edit_body, IMAGES_EDIT)
+	}
 
-		let res = self.post_multipart(IMAGES_VARIATIONS, send_data)?;
-		let images: Images = serde_json::from_value(res.clone()).unwrap();
-		Ok(images)
+	fn image_variation(&self, images_edit_body: ImagesEditBody) -> ApiResult<Images> {
+		self.image_build_send_data_from_body(images_edit_body, IMAGES_VARIATIONS)
 	}
 }
 

src/apis/edits.rs

@@ -3,7 +3,6 @@ use serde::{Deserialize, Serialize};
 pub mod audio;
 pub mod chat;
 pub mod completions;
-pub mod edits;
 pub mod embeddings;
 pub mod images;
 pub mod models;
@@ -15,8 +14,6 @@ const MODELS_RETRIEVE: &str = "models/";
 const COMPLETION_CREATE: &str = "completions";
 // Chat API
 const CHAT_COMPLETION_CREATE: &str = "chat/completions";
-// Edits API
-const EDIT_CREATE: &str = "edits";
 // Images API
 const IMAGES_CREATE: &str = "images/generations";
 const IMAGES_EDIT: &str = "images/edits";

src/apis/images.rs

@@ -19,23 +19,6 @@ pub struct Model {
 	pub id: String,
 	pub object: Option<String>,
 	pub owned_by: Option<String>,
-	pub permission: Vec<Permission>,
-}
-
-#[derive(Debug, Serialize, Deserialize)]
-pub struct Permission {
-	pub id: String,
-	pub object: Option<String>,
-	pub created: u64,
-	pub allow_create_engine: bool,
-	pub allow_sampling: bool,
-	pub allow_logprobs: bool,
-	pub allow_search_indices: bool,
-	pub allow_view: bool,
-	pub allow_fine_tuning: bool,
-	pub organization: Option<String>,
-	pub group: Option<String>,
-	pub is_blocking: bool,
 }
 
 pub trait ModelsApi {
@@ -79,7 +62,7 @@ mod tests {
 	#[test]
 	fn test_get_model() {
 		let openai = new_test_openai();
-		let model = openai.models_retrieve("babbage").unwrap();
-		assert_eq!("babbage", model.id);
+		let model = openai.models_retrieve("babbage-002").unwrap();
+		assert_eq!("babbage-002", model.id);
 	}
 }

src/apis/mod.rs

@@ -11,7 +11,7 @@
 //! use openai_api_rust::*;
 //! use openai_api_rust::chat::*;
 //! use openai_api_rust::completions::*;
-//! 
+//!
 //! fn main() {
 //!     // Load API key from environment OPENAI_API_KEY.
 //!     // You can also hadcode through `Auth::new(<your_api_key>)`, but it is not recommended.
@@ -37,38 +37,35 @@
 //!     assert!(message.content.contains("Hello"));
 //! }
 //! ```
-//! 
+//!
 //! ## Use proxy
-//! 
+//!
 //! ```rust
 //! // Load proxy from env
 //! let openai = OpenAI::new(auth, "https://api.openai.com/v1/")
 //!        .use_env_proxy();
-//! 
+//!
 //! // Set the proxy manually
 //! let openai = OpenAI::new(auth, "https://api.openai.com/v1/")
 //!        .set_proxy("http://127.0.0.1:1080");
 //! ```
 
-
-
 #![warn(unused_crate_dependencies)]
 
 pub mod apis;
-use std::fmt::{Display, Formatter, self};
+use std::fmt::{self, Display, Formatter};
 
 pub use apis::*;
 pub mod openai;
 pub use openai::*;
+mod mpart;
 mod requests;
 
 use log as _;
 
 pub type Json = serde_json::Value;
 pub type ApiResult<T> = Result<T, Error>;
 
-pub use openai::*;
-
 #[derive(Debug)]
 pub enum Error {
 	/// An Error returned by the API
@@ -78,10 +75,10 @@ pub enum Error {
 }
 
 impl Display for Error {
-    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
-        match self {
-            Error::ApiError(msg) => write!(f, "API error: {}", msg),
-            Error::RequestError(msg) => write!(f, "Request error: {}", msg),
-        }
-    }
-}
+	fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+		match self {
+			Error::ApiError(msg) => write!(f, "API error: {}", msg),
+			Error::RequestError(msg) => write!(f, "Request error: {}", msg),
+		}
+	}
+}