Struct async_openai::types::CreateImageRequest

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

Fields

prompt: String

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

model: Option<ImageModel>

The model to use for image generation.

n: Option<u8>

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

quality: Option<ImageQuality>

The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

response_format: Option<ResponseFormat>

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

size: Option<ImageSize>

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.

style: Option<ImageStyle>

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.

user: Option<String>

A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. Learn more.

Trait Implementations

impl Clone for CreateImageRequest

fn clone(&self) -> CreateImageRequest

Returns a copy 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() -> CreateImageRequest

Returns the “default value” for a type.

impl PartialEq for CreateImageRequest

fn eq(&self, other: &CreateImageRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for CreateImageRequest