Struct openai_req::image::ImageEditRequest

pub struct ImageEditRequest { /* private fields */ }

Generates image edit for provided image. Details at https://platform.openai.com/docs/api-reference/images/create-edit

Usage example

 use openai_req::image::ImageEditRequest;
 use std::path::PathBuf;
 use openai_req::FormRequest;

 let image_path = PathBuf::from("tests/generated.png");
 let mask_path = PathBuf::from("tests/mask.png");
 let prompt = "remove text".to_string();
 let req = ImageEditRequest::new(image_path,prompt)?
         .mask(mask_path)?;
 let res = req.run(&client).await?;

Implementations

impl ImageEditRequest

pub fn new(image: PathBuf, prompt: String) -> Result<Self, Error>

Will check if provided path exists, and return io::Error if it does not.

pub fn mask(self, mask: PathBuf) -> Result<Self, Error>

Will check if provided path exists, and return io::Error if it does not.

pub fn n(self, n: i32) -> Self

pub fn size(self, size: ImageSize) -> Self

pub fn response_format(self, response_format: String) -> Self

pub fn user(self, user: String) -> Self

Trait Implementations

impl Clone for ImageEditRequest

fn clone(&self) -> ImageEditRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageEditRequest

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

Formats the value using the given formatter.

impl FormRequest<ImageResponse> for ImageEditRequest

const ENDPOINT: &'static str = "/images/edits"

fn run<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 OpenAiClient ) -> Pin<Box<dyn Future<Output = Result<TRes>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,