Enum UserInput 

pub enum UserInput {
    Text {
        text: String,
    },
    Image {
        image_url: String,
        detail: Option<ImageDetail>,
    },
    LocalImage {
        path: PathBuf,
        detail: Option<ImageDetail>,
    },
    Audio {
        audio_url: String,
    },
    LocalAudio {
        path: PathBuf,
    },
}

One ordered user-supplied prompt item.

Variants

Text

Model-visible text.

Fields

text: String

Text supplied by the user.

Image

An image supplied as a URL or data URL.

Fields

image_url: String

Image URL visible to the model.

detail: Option<ImageDetail>

Optional image-detail policy.

LocalImage

An image loaded from the local filesystem by a native runtime.

Fields

path: PathBuf

Path to the local image.

detail: Option<ImageDetail>

Optional image-detail policy.

Audio

A reserved remote audio input.

Fields

audio_url: String

Audio URL retained by the input contract.

LocalAudio

A reserved local audio input.

Fields

path: PathBuf

Path retained by the input contract.

Implementations

impl UserInput

pub const fn text_bytes(&self) -> usize

Returns the UTF-8 byte length when this is text, or zero for media.

pub fn text_chars(&self) -> usize

Returns the Unicode scalar-value count when this is text, or zero for media.

pub fn is_empty(&self) -> bool

Returns whether this item contains neither non-whitespace text nor media.

Trait Implementations

impl Clone for UserInput

fn clone(&self) -> UserInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UserInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.