Enum UserContent 

pub enum UserContent {
    Text(Text),
    ToolResult(ToolResult),
    Image(Image),
    Audio(Audio),
    Video(Video),
    Document(Document),
}

Describes the content of a message, which can be text, a tool result, an image, audio, or a document. Dependent on provider supporting the content type. Multimedia content is generally base64 (defined by it’s format) encoded but additionally supports urls (for some providers).

Variants

Text(Text)

Plain text user content.

ToolResult(ToolResult)

Result of a tool call returned as user-visible context to the model.

Image(Image)

Image content.

Audio(Audio)

Audio content.

Video(Video)

Video content.

Document(Document)

Document content.

Implementations

impl UserContent

pub fn text(text: impl Into<String>) -> UserContent

Helper constructor to make creating user text content easier.

pub fn image_base64( data: impl Into<String>, media_type: Option<ImageMediaType>, detail: Option<ImageDetail>, ) -> UserContent

Helper constructor to make creating user image content easier.

pub fn image_raw( data: impl Into<Vec<u8>>, media_type: Option<ImageMediaType>, detail: Option<ImageDetail>, ) -> UserContent

Helper constructor to make creating user image content from raw unencoded bytes easier.

pub fn image_url( url: impl Into<String>, media_type: Option<ImageMediaType>, detail: Option<ImageDetail>, ) -> UserContent

Helper constructor to make creating user image content easier.

pub fn audio( data: impl Into<String>, media_type: Option<AudioMediaType>, ) -> UserContent

Helper constructor to make creating user audio content easier.

pub fn audio_raw( data: impl Into<Vec<u8>>, media_type: Option<AudioMediaType>, ) -> UserContent

Helper constructor to make creating user audio content from raw unencoded bytes easier.

pub fn audio_url( url: impl Into<String>, media_type: Option<AudioMediaType>, ) -> UserContent

Helper to create an audio resource from a URL

pub fn video( data: impl Into<String>, media_type: Option<VideoMediaType>, ) -> UserContent

Helper constructor to make creating user video content easier.

pub fn video_raw( data: impl Into<Vec<u8>>, media_type: Option<VideoMediaType>, ) -> UserContent

Helper constructor to make creating user video content from raw unencoded bytes easier.

pub fn video_url( url: impl Into<String>, media_type: Option<VideoMediaType>, ) -> UserContent

Helper to create a video resource from a URL

pub fn document( data: impl Into<String>, media_type: Option<DocumentMediaType>, ) -> UserContent

Helper constructor to make creating user document content easier. This creates a document that assumes the data being passed in is a raw string.

pub fn document_raw( data: impl Into<Vec<u8>>, media_type: Option<DocumentMediaType>, ) -> UserContent

Helper to create a document from raw unencoded bytes

pub fn document_url( url: impl Into<String>, media_type: Option<DocumentMediaType>, ) -> UserContent

Helper to create a document from a URL

pub fn tool_result( id: impl Into<String>, content: OneOrMany<ToolResultContent>, ) -> UserContent

Helper constructor to make creating user tool result content easier.

pub fn tool_result_with_call_id( id: impl Into<String>, call_id: String, content: OneOrMany<ToolResultContent>, ) -> UserContent

Helper constructor to make creating user tool result content easier.

Trait Implementations

impl Clone for UserContent

fn clone(&self) -> UserContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<String> for UserContent

fn from(text: String) -> UserContent

Converts to this type from the input type.

impl From<UserContent> for Message

fn from(content: UserContent) -> Message

Converts to this type from the input type.

impl From<UserContent> for UserContent

fn from(content: UserContent) -> UserContent

Converts to this type from the input type.

impl PartialEq for UserContent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for UserContent

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.

impl StructuralPartialEq for UserContent

impl TryFrom<UserContent> for Part

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( content: UserContent, ) -> Result<Part, <Part as TryFrom<UserContent>>::Error>

Performs the conversion.

impl TryFrom<UserContent> for Content

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( content: UserContent, ) -> Result<Content, <Content as TryFrom<UserContent>>::Error>

Performs the conversion.

impl TryFrom<UserContent> for UserContent

type Error = MessageError

The type returned in the event of a conversion error.

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

Performs the conversion.