Struct ImageEditRequestBuilder

pub struct ImageEditRequestBuilder { /* private fields */ }

Builder for creating a ImageEditRequest instance.

Implementations

impl ImageEditRequestBuilder

pub fn new( model: impl Into<String>, image: FileObject, prompt: impl Into<String>, ) -> Self

Create a new builder with the given image, prompt, and mask.

pub fn with_negative_prompt(self, negative_prompt: impl Into<String>) -> Self

Set negative prompt

pub fn with_mask(self, mask: FileObject) -> Self

Set an additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must have the same dimensions as image.

pub fn with_number_of_images(self, n: u64) -> Self

Set the number of images to generate.

pub fn with_size(self, size: impl Into<String>) -> Self

Set the size of the generated images.

pub fn with_response_format(self, response_format: ResponseFormat) -> Self

Set the format in which the generated images are returned.

pub fn with_user(self, user: impl Into<String>) -> Self

Set the user id

pub fn with_cfg_scale(self, cfg_scale: f32) -> Self

Set the unconditional guidance scale. This param is only supported for stable-diffusion.cpp.

pub fn with_sample_method(self, sample_method: SamplingMethod) -> Self

Set the sampling method. This param is only supported for stable-diffusion.cpp.

pub fn with_steps(self, steps: usize) -> Self

Set the number of sample steps. This param is only supported for stable-diffusion.cpp.

pub fn with_image_size(self, height: usize, width: usize) -> Self

Set the image size.

pub fn with_control_strength(self, control_strength: f32) -> Self

Set the strength to apply Control Net. This param is only supported for stable-diffusion.cpp.

pub fn with_control_image(self, control_image: FileObject) -> Self

Set the image to control the generation. This param is only supported for stable-diffusion.cpp.

pub fn with_seed(self, seed: i32) -> Self

Set the RNG seed. Negative value means to use random seed. This param is only supported for stable-diffusion.cpp.

pub fn with_strength(self, strength: f32) -> Self

Set the strength for noising/unnoising. This param is only supported for stable-diffusion.cpp.

pub fn with_scheduler(self, scheduler: Scheduler) -> Self

Set the denoiser sigma scheduler. This param is only supported for stable-diffusion.cpp.

pub fn with_apply_canny_preprocessor( self, apply_canny_preprocessor: bool, ) -> Self

Set whether to apply the canny preprocessor. This param is only supported for stable-diffusion.cpp.

pub fn with_style_ratio(self, style_ratio: f32) -> Self

Set the strength for keeping input identity. This param is only supported for stable-diffusion.cpp.

pub fn build(self) -> ImageEditRequest

Build the request.