Struct CreateImageRequestBuilder

pub struct CreateImageRequestBuilder { /* private fields */ }

Builder for CreateImageRequest.

Implementations

impl CreateImageRequestBuilder

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

A text description of the desired image(s). The maximum length is 4000 characters for dall-e-3.

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

The model to use for image generation. Only support Dall-e-3

pub fn n(&mut self, value: usize) -> &mut Self

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

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

The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

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

The format in which the generated images are returned. Must be one of url or b64_json.

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

The size of the generated images. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.

pub fn style(&mut self, value: ImageStyle) -> &mut Self

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.

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.

pub fn build( &self, ) -> Result<CreateImageRequest, CreateImageRequestBuilderError>

Builds a new CreateImageRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateImageRequestBuilder

fn clone(&self) -> CreateImageRequestBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CreateImageRequestBuilder

fn default() -> Self

Returns the “default value” for a type.