Struct CreateImageRequest 

pub struct CreateImageRequest {
    pub model: Option<String>,
    pub n: NonZeroU64,
    pub prompt: String,
    pub quality: Option<CreateImageRequestQuality>,
    pub response_format: CreateImageRequestResponseFormat,
    pub size: Option<ImageSize>,
}

Request body for creating an image via the OpenAI-compatible Images API.

JSON schema

{
 "description": "Request body for creating an image via the OpenAI-compatible Images API.\n",
 "type": "object",
 "required": [
   "prompt"
 ],
 "properties": {
   "model": {
     "description": "Model ID to use for image generation.",
     "type": "string"
   },
   "n": {
     "description": "Number of images to generate.",
     "default": 1,
     "type": "integer",
     "maximum": 10.0,
     "minimum": 1.0
   },
   "prompt": {
     "description": "A text description of the desired image.",
     "type": "string"
   },
   "quality": {
     "description": "The quality of the image. `auto` selects the best quality for\nthe model. The GPT image models support `low`, `medium`, and\n`high`; `dall-e-3` supports `standard` and `hd`; `dall-e-2`\nsupports only `standard`.\n",
     "type": "string",
     "enum": [
       "auto",
       "standard",
       "hd",
       "low",
       "medium",
       "high"
     ]
   },
   "response_format": {
     "description": "The format in which the generated images are returned. Must be\none of `url` or `b64_json`.\n",
     "default": "url",
     "type": "string",
     "enum": [
       "url",
       "b64_json"
     ]
   },
   "size": {
     "$ref": "#/definitions/ImageSize"
   }
 }
}

Fields

model: Option<String>

Model ID to use for image generation.

n: NonZeroU64

Number of images to generate.

prompt: String

A text description of the desired image.

quality: Option<CreateImageRequestQuality>

The quality of the image. auto selects the best quality for the model. The GPT image models support low, medium, and high; dall-e-3 supports standard and hd; dall-e-2 supports only standard.

response_format: CreateImageRequestResponseFormat

The format in which the generated images are returned. Must be one of url or b64_json.

size: Option<ImageSize>

Trait Implementations

impl Clone for CreateImageRequest

fn clone(&self) -> CreateImageRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateImageRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateImageRequest

fn default() -> Self

Mirrors the schema defaults: n = 1, response_format = url.

impl<'de> Deserialize<'de> for CreateImageRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateImageRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.