Struct CreateImageRequest 

pub struct CreateImageRequest {
    pub prompt: String,
    pub model: Option<String>,
    pub n: Option<i32>,
    pub quality: Option<ImageQuality>,
    pub response_format: Option<ImageResponseFormat>,
    pub size: Option<ImageSize>,
    pub style: Option<ImageStyle>,
    pub user: Option<String>,
}

Request to generate an image.

Example

use portkey_sdk::model::{CreateImageRequest, ImageSize, ImageQuality, ImageStyle};

let request = CreateImageRequest {
    prompt: "A cute baby sea otter".to_string(),
    model: Some("dall-e-3".to_string()),
    n: Some(1),
    quality: Some(ImageQuality::Hd),
    response_format: None,
    size: Some(ImageSize::Size1024x1024),
    style: Some(ImageStyle::Vivid),
    user: None,
};

Fields

prompt: String

A text description of the desired image(s).

Maximum length is 1000 characters for DALL-E 2 and 4000 characters for DALL-E 3.

model: Option<String>

The model to use for image generation (default: dall-e-2)

n: Option<i32>

Number of images to generate (1-10).

For DALL-E 3, only n=1 is supported.

quality: Option<ImageQuality>

Image quality (DALL-E 3 only).

hd creates images with finer details and greater consistency.

response_format: Option<ImageResponseFormat>

Format for the generated images.

URLs are only valid for 60 minutes after generation.

size: Option<ImageSize>

Size of the generated images.

For DALL-E 2: 256x256, 512x512, or 1024x1024. For DALL-E 3: 1024x1024, 1792x1024, or 1024x1792.

style: Option<ImageStyle>

Style of the generated images (DALL-E 3 only).

vivid generates hyper-real and dramatic images. natural generates more natural, less hyper-real images.

user: Option<String>

A unique identifier representing your end-user

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<'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.