Struct ImageVariationRequest 

pub struct ImageVariationRequest {
    pub image: PathBuf,
    pub model: Option<String>,
    pub n: Option<u32>,
    pub response_format: Option<ImageResponseFormat>,
    pub size: Option<VariationSize>,
    pub user: Option<String>,
    pub extra_body_map: Option<Map<String, Value>>,
}

Creates a variation of a given image.

Fields

image: PathBuf

The image to use as the basis for the variation(s), as a file path.

Must be a valid PNG file, less than 4MB, and square.

model: Option<String>

The model to use for image generation. Only dall-e-2 is supported at this time.

n: Option<u32>

The number of images to generate. Must be between 1 and 10.

response_format: Option<ImageResponseFormat>

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.

size: Option<VariationSize>

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

user: Option<String>

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

extra_body_map: Option<Map<String, Value>>

Additional JSON properties, sent as extra multipart text fields (strings verbatim, other JSON values serialized).

Trait Implementations

impl Clone for ImageVariationRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageVariationRequest

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

Formats the value using the given formatter.

impl Default for ImageVariationRequest

fn default() -> Self

Returns the “default value” for a type.

impl Post for ImageVariationRequest

fn build_url(&self, base_url: &str) -> Result<String, OapiError>

Builds the URL for the request.

base_url should be like https://api.openai.com/v1

fn is_streaming(&self) -> bool

impl PostNoStream for ImageVariationRequest

async fn get_response_string( &self, client: &Client, base_url: &str, options: &RequestOptions, ) -> Result<String, OapiError>

Sends an image variation POST request using multipart/form-data format, following the field layout of the official SDK.

type Response = ImagesResponse

fn get_response( &self, client: &Client, url: &str, options: &RequestOptions, ) -> impl Future<Output = Result<Self::Response, OapiError>> + Send + Sync

Sends a POST request and deserializes the response.

impl Serialize for ImageVariationRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.