Struct async_openai::types::CreateImageEditRequestArgs

pub struct CreateImageEditRequestArgs { /* private fields */ }

Builder for CreateImageEditRequest.

Implementations

impl CreateImageEditRequestArgs

pub fn image<VALUE: Into<ImageInput>>(&mut self, value: VALUE) -> &mut Self

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

pub fn prompt<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

A text description of the desired image(s). The maximum length is 1000 characters.

pub fn mask<VALUE: Into<ImageInput>>(&mut self, value: VALUE) -> &mut Self

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

pub fn model<VALUE: Into<ImageModel>>(&mut self, value: VALUE) -> &mut Self

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

pub fn n<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

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

pub fn size<VALUE: Into<DallE2ImageSize>>(&mut self, value: VALUE) -> &mut Self

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

pub fn response_format<VALUE: Into<ResponseFormat>>( &mut self, value: VALUE ) -> &mut Self

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

pub fn user<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn build(&self) -> Result<CreateImageEditRequest, OpenAIError>

Builds a new CreateImageEditRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateImageEditRequestArgs

fn clone(&self) -> CreateImageEditRequestArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateImageEditRequestArgs

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

Formats the value using the given formatter.

impl Default for CreateImageEditRequestArgs

fn default() -> Self

Returns the “default value” for a type.