Struct Images 

pub struct Images<'c, C: Config> { /* private fields */ }

Given a prompt and/or an input image, the model will generate a new image.

Related guide: Image generation

Implementations

impl<'c, C: Config> Images<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub async fn generate( &self, request: CreateImageRequest, ) -> Result<ImagesResponse, OpenAIError>

Creates an image given a prompt. Creates an image given a prompt.

pub async fn generate_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Creates an image given a prompt.

pub async fn generate_stream( &self, request: CreateImageRequest, ) -> Result<ImageGenStream, OpenAIError>

Creates an image given a prompt. Creates an image given a prompt.

pub async fn generate_stream_byot<T0: Serialize, R>( &self, request: T0, ) -> Result<Pin<Box<dyn Stream<Item = Result<R, OpenAIError>> + Send>>, OpenAIError>

where R: Send + 'static + DeserializeOwned,

Creates an image given a prompt.

pub async fn edit( &self, request: CreateImageEditRequest, ) -> Result<ImagesResponse, OpenAIError>

Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2. Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.

pub async fn edit_byot<T0: Clone, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

where Form: AsyncTryFrom<T0, Error = OpenAIError>,

Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.

pub async fn edit_stream( &self, request: CreateImageEditRequest, ) -> Result<ImageEditStream, OpenAIError>

Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2. Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.

pub async fn edit_stream_byot<T0: Clone, R>( &self, request: T0, ) -> Result<Pin<Box<dyn Stream<Item = Result<R, OpenAIError>> + Send>>, OpenAIError>

where R: Send + 'static + DeserializeOwned, Form: AsyncTryFrom<T0, Error = OpenAIError>,

Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.

pub async fn create_variation( &self, request: CreateImageVariationRequest, ) -> Result<ImagesResponse, OpenAIError>

Creates a variation of a given image. This endpoint only supports dall-e-2. Creates a variation of a given image. This endpoint only supports dall-e-2.

pub async fn create_variation_byot<T0: Clone, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

where Form: AsyncTryFrom<T0, Error = OpenAIError>,

Creates a variation of a given image. This endpoint only supports dall-e-2.