Struct ImageData 

pub struct ImageData {
    pub url: Option<String>,
    pub b64_json: Option<String>,
    pub revised_prompt: Option<String>,
}

Individual image data from generation response.

Fields

url: Option<String>

URL of the generated image (if response_format = url) Note: URLs are only valid for 60 minutes after generation

b64_json: Option<String>

Base64-encoded image data (if response_format = b64_json)

revised_prompt: Option<String>

The revised prompt used by the model (DALL-E 3 only) DALL-E 3 may revise the original prompt for safety or quality

Implementations

impl ImageData

pub fn as_bytes(&self) -> Option<Result<Vec<u8>, DecodeError>>

Decodes base64 image data to bytes.

Returns None if no b64_json data is present. Returns Some(Err(...)) if base64 decoding fails.

Example

use openai_tools::images::response::ImageData;
use std::fs;

if let Some(bytes_result) = image_data.as_bytes() {
    let bytes = bytes_result?;
    fs::write("output.png", bytes)?;
}

pub fn has_url(&self) -> bool

Returns true if this image data contains a URL.

pub fn has_b64(&self) -> bool

Returns true if this image data contains base64 data.

Trait Implementations

impl Clone for ImageData

fn clone(&self) -> ImageData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.