Struct EditImageJsonRequestArgs 

pub struct EditImageJsonRequestArgs { /* private fields */ }

Available on crate feature image-types only.

Builder for EditImageJsonRequest.

Implementations

impl EditImageJsonRequestArgs

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

The model to use for image editing.

pub fn images<VALUE: Into<Vec<ImageRefParam>>>( &mut self, value: VALUE, ) -> &mut Self

Input image references to edit. For GPT image models, you can provide up to 16 images.

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

An optional mask image reference indicating which areas of the image should be edited.

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

A text description of the desired image edit.

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

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

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

The quality of the image that will be generated.

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. Supports high and low. Defaults to low.

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

The size of the generated image.

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

A unique identifier representing your end-user.

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

The output format for the generated image.

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

The compression level (0-100%) for the generated images.

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

Control the content-moderation level for images.

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

The background style for the generated image.

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

Whether to stream the image generation. Defaults to false.

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

The number of partial images to generate during streaming.

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

Builds a new EditImageJsonRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for EditImageJsonRequestArgs

fn clone(&self) -> EditImageJsonRequestArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditImageJsonRequestArgs

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

Formats the value using the given formatter.

impl Default for EditImageJsonRequestArgs

fn default() -> Self

Returns the “default value” for a type.