Skip to main content

CreateImageParametersBuilder

Struct CreateImageParametersBuilder 

Source
pub struct CreateImageParametersBuilder { /* private fields */ }
Expand description

Builder for CreateImageParameters.

Implementations§

Source§

impl CreateImageParametersBuilder

Source

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

所需图像的文字描述。对于gpt-image-1最大长度为32000个字符,对于dall-e-2为1000个字符,对于dall-e-3为4000个字符。

Source

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

允许为生成的图像设置背景透明度。此参数仅支持gpt-image-1。 必须是transparent、opaque或auto(默认值)之一。当使用auto时,模型将自动确定图像的最佳背景。 如果设置为transparent,输出格式需要支持透明度,因此应设置为png(默认值)或webp。

Source

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

用于图像生成的模型。

Source

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

控制gpt-image-1生成图像的内容审核级别。必须是low(较少限制性过滤)或auto(默认值)。

Source

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

要生成的图像数量。必须介于1到10之间。对于dall-e-3,仅支持n=1。

Source

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

生成图像的压缩级别(0-100%)。此参数仅支持gpt-image-1与webp或jpeg输出格式,并默认为100。

Source

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

返回生成图像的格式。此参数仅支持gpt-image-1。必须是png、jpeg或webp之一。

Source

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

要生成的部分图像数量。此参数用于返回部分图像的流式响应。 值必须在0到3之间。设置为0时,响应将是单个图像在一个流事件中发送。

Source

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

将生成的图像质量。hd创建具有更精细细节和更大一致性的图像。 gpt-image-1支持high、medium和low。dall-e-3支持hd和standard。dall-e-2只支持standard选项。

Source

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

返回生成图像的格式。必须是url或b64_json之一。

Source

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

生成图像的尺寸。对于gpt-image-1必须是1024x1024、1536x1024(横向)、1024x1536(纵向)或auto(默认值), 对于dall-e-2是256x256、512x512或1024x1024之一,对于dall-e-3是1024x1024、1792x1024或1024x1792之一。

Source

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

在流模式下生成图像。

Source

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

生成图像的风格。此参数仅支持dall-e-3。必须是vivid或natural之一。 Vivid使模型倾向于生成超现实和戏剧性图像。 Natural使模型产生更自然、不太超现实的图像。

Source

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

一个稳定标识符,用于帮助检测可能违反OpenAI使用政策的应用程序用户。

Source

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

OpenAI用于缓存类似请求响应以优化缓存命中率。

Source

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

表示您的最终用户的唯一标识符,可以帮助OpenAI监控和检测滥用行为。

Source

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

附加参数

Source

pub fn build( &self, ) -> Result<CreateImageParameters, CreateImageParametersBuilderError>

Builds a new CreateImageParameters.

§Errors

If a required field has not been initialized.

Trait Implementations§

Source§

impl Clone for CreateImageParametersBuilder

Source§

fn clone(&self) -> CreateImageParametersBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for CreateImageParametersBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.