Skip to main content

CreateImageParameters

Struct CreateImageParameters 

Source
pub struct CreateImageParameters {
Show 17 fields pub prompt: String, pub background: Option<BackgroundStyle>, pub model: Option<String>, pub moderation: Option<ModerationLevel>, pub n: Option<u32>, pub output_compression: Option<u32>, pub output_format: Option<OutputFormat>, pub partial_images: Option<u32>, pub quality: Option<ImageQuality>, pub response_format: Option<ResponseFormat>, pub size: Option<ImageSize>, pub stream: Option<bool>, pub style: Option<ImageStyle>, pub safety_identifier: Option<String>, pub prompt_cache_key: Option<String>, pub user: Option<String>, pub ext: Option<HashMap<String, Value>>,
}

Fields§

§prompt: String

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

§background: Option<BackgroundStyle>

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

§model: Option<String>

用于图像生成的模型。

§moderation: Option<ModerationLevel>

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

§n: Option<u32>

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

§output_compression: Option<u32>

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

§output_format: Option<OutputFormat>

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

§partial_images: Option<u32>

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

§quality: Option<ImageQuality>

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

§response_format: Option<ResponseFormat>

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

§size: Option<ImageSize>

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

§stream: Option<bool>

在流模式下生成图像。

§style: Option<ImageStyle>

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

§safety_identifier: Option<String>

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

§prompt_cache_key: Option<String>

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

§user: Option<String>

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

§ext: Option<HashMap<String, Value>>

附加参数

Trait Implementations§

Source§

impl Clone for CreateImageParameters

Source§

fn clone(&self) -> CreateImageParameters

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 Debug for CreateImageParameters

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CreateImageParameters

Source§

fn default() -> CreateImageParameters

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

impl<'de> Deserialize<'de> for CreateImageParameters

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CreateImageParameters

Source§

fn eq(&self, other: &CreateImageParameters) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for CreateImageParameters

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CreateImageParameters

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,