async_openai/
image.rs

1use crate::{
2    config::Config,
3    error::OpenAIError,
4    types::{
5        CreateImageEditRequest, CreateImageRequest, CreateImageVariationRequest, ImagesResponse,
6    },
7    Client,
8};
9
10/// Given a prompt and/or an input image, the model will generate a new image.
11///
12/// Related guide: [Image generation](https://platform.openai.com/docs/guides/images)
13pub struct Images<'c, C: Config> {
14    client: &'c Client<C>,
15}
16
17impl<'c, C: Config> Images<'c, C> {
18    pub fn new(client: &'c Client<C>) -> Self {
19        Self { client }
20    }
21
22    /// Creates an image given a prompt.
23    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
24    pub async fn create(&self, request: CreateImageRequest) -> Result<ImagesResponse, OpenAIError> {
25        self.client.post("/images/generations", request).await
26    }
27
28    /// Creates an edited or extended image given an original image and a prompt.
29    #[crate::byot(
30        T0 = Clone,
31        R = serde::de::DeserializeOwned,
32        where_clause =  "reqwest::multipart::Form: crate::traits::AsyncTryFrom<T0, Error = OpenAIError>",
33    )]
34    pub async fn create_edit(
35        &self,
36        request: CreateImageEditRequest,
37    ) -> Result<ImagesResponse, OpenAIError> {
38        self.client.post_form("/images/edits", request).await
39    }
40
41    /// Creates a variation of a given image.
42    #[crate::byot(
43        T0 = Clone,
44        R = serde::de::DeserializeOwned,
45        where_clause =  "reqwest::multipart::Form: crate::traits::AsyncTryFrom<T0, Error = OpenAIError>",
46    )]
47    pub async fn create_variation(
48        &self,
49        request: CreateImageVariationRequest,
50    ) -> Result<ImagesResponse, OpenAIError> {
51        self.client.post_form("/images/variations", request).await
52    }
53}