Struct CreateImageEditRequestArgs 

pub struct CreateImageEditRequestArgs { /* private fields */ }

Builder for CreateImageEditRequest.

Implementations

impl CreateImageEditRequestArgs

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

The image(s) to edit. Must be a supported image file or an array of images.

For gpt-image-1, each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images.

For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

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 for dall-e-2, and 32000 characters for gpt-image-1.

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. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

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

Allows to set transparency for the background of the generated image(s). This parameter is only supported for gpt-image-1. Must be one of transparent, opaque or auto (default value). When auto is used, the model will automatically determine the best background for the image.

If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

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

The model to use for image generation. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

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<ImageSize>>(&mut self, value: VALUE) -> &mut Self

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for gpt-image-1, and one of 256x256, 512x512, or 1024x1024 for dall-e-2.

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

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. This parameter is only supported for dall-e-2, as gpt-image-1 will always return base64-encoded images.

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

The format in which the generated images are returned. This parameter is only supported for gpt-image-1. Must be one of png, jpeg, or webp. The default value is png.

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

The compression level (0-100%) for the generated images. This parameter is only supported for gpt-image-1 with the webp or jpeg output formats, and defaults to 100.

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

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

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

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

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

Edit the image in streaming mode. Defaults to false. See the Image generation guide for more information.

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

The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event. Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.

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

The quality of the image that will be generated. high, medium and low are only supported for gpt-image-1. dall-e-2 only supports standard quality. Defaults to auto.

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 duplicate 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.