openai_struct/models/
create_image_edit_request.rs

1/*
2 * OpenAI API
3 *
4 * The OpenAI REST API. Please see pub https://platform.openai.com/docs/api-reference for more details.
5 *
6 * OpenAPI spec pub version: 2.3.0
7 *
8 * Generated pub by: https://github.com/swagger-api/swagger-codegen.git
9 */
10
11#[allow(unused_imports)]
12use serde_json::Value;
13
14#[derive(Debug, Serialize, Deserialize)]
15pub struct CreateImageEditRequest {
16    /// The image(s) to edit. Must be a supported image file or an array of images.  For `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less  than 25MB. You can provide up to 16 images.  For `dall-e-2`, you can only provide one image, and it should be a square  `png` file less than 4MB.
17    #[serde(rename = "image")]
18    pub image: Value,
19    /// An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`.
20    #[serde(rename = "mask")]
21    pub mask: Option<Vec<u8>>,
22    /// The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are supported. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1` is used.
23    #[serde(rename = "model")]
24    pub model: Option<Value>,
25    /// The number of images to generate. Must be between 1 and 10.
26    #[serde(rename = "n")]
27    pub n: Option<i32>,
28    /// A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2`, and 32000 characters for `gpt-image-1`.
29    #[serde(rename = "prompt")]
30    pub prompt: String,
31    /// The quality of the image that will be generated. `high`, `medium` and `low` are only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality. Defaults to `auto`.
32    #[serde(rename = "quality")]
33    pub quality: Option<String>,
34    /// The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for `dall-e-2`, as `gpt-image-1` will always return base64-encoded images.
35    #[serde(rename = "response_format")]
36    pub response_format: Option<String>,
37    /// The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
38    #[serde(rename = "size")]
39    pub size: Option<String>,
40    /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).
41    #[serde(rename = "user")]
42    pub user: Option<String>,
43}
openai_struct/models/create_image_edit_request.rs

openai_struct/models/
create_image_edit_request.rs
