Struct ImagesResponse

pub struct ImagesResponse {
    pub created: i64,
    pub data: Option<Vec<Image>>,
    pub background: Option<ImagesResponseBackground>,
    pub output_format: Option<ImagesResponseOutputFormat>,
    pub size: Option<ImagesResponseSize>,
    pub quality: Option<ImagesResponseQuality>,
    pub usage: Option<ImagesResponseUsage>,
}

The response from the image generation endpoint.

Fields

created: i64

The Unix timestamp (in seconds) of when the image was created.

data: Option<Vec<Image>>

The list of generated images.

background: Option<ImagesResponseBackground>

The background parameter used for the image generation. Either transparent or opaque.

output_format: Option<ImagesResponseOutputFormat>

The output format of the image generation. Either png, webp, or jpeg.

size: Option<ImagesResponseSize>

The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.

quality: Option<ImagesResponseQuality>

The quality of the image generated. Either low, medium, or high.

usage: Option<ImagesResponseUsage>

For gpt-image-1 only, the token usage information for the image generation.

Implementations

impl ImagesResponse

pub fn builder() -> ImagesResponseBuilder<((), (), (), (), (), (), ())>

Create a builder for building ImagesResponse. On the builder, call .created(...), .data(...)(optional), .background(...)(optional), .output_format(...)(optional), .size(...)(optional), .quality(...)(optional), .usage(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ImagesResponse.

Trait Implementations

impl Clone for ImagesResponse

fn clone(&self) -> ImagesResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImagesResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImagesResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ImagesResponse

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ImagesResponse

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 ImagesResponse