Struct InputImage 

pub struct InputImage {
    pub image_url: Option<String>,
    pub file_id: Option<String>,
    pub detail: Option<String>,
}

Represents an image input part, specified either by URL or File ID. Learn about image inputs.

Used By

• InputContentPart
• ChatCompletionRequestMessageContentPartImage (within chat_shared.rs)

Fields

image_url: Option<String>

The URL of the image or a base64 encoded data URL.

file_id: Option<String>

The ID of an uploaded file to use as input.

detail: Option<String>

Specifies the detail level of the image (low, high, or auto). Defaults to auto.

Implementations

impl InputImage

pub fn former() -> InputImageFormer<InputImageFormerDefinition<(), InputImage, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations

impl Clone for InputImage

fn clone(&self) -> InputImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputImage

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

Formats the value using the given formatter.

impl Default for InputImage

fn default() -> InputImage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InputImage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for InputImage

where __End: FormingEnd<InputImageFormerDefinitionTypes<__Context, __Formed>>,

type Definition = InputImageFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = InputImageFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for InputImage

type Types = InputImageFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for InputImage

where Definition: FormerDefinition<Storage = InputImageFormerStorage>,

type Former = InputImageFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for InputImage

type Storage = InputImageFormerStorage

The storage type used for forming the entity.

impl PartialEq for InputImage

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for InputImage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InputImage