Skip to main content

UserContent

Enum UserContent 

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

User text, tool results, or media. Supported source kinds and media types depend on the target provider.

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§

Source§

impl UserContent

Source

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

Creates user text content.

Source

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

Creates user image content from base64-encoded data.

Source

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

Creates user image content from unencoded bytes.

Source

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

Creates user image content referencing a URL.

Source

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

Creates user audio content from base64-encoded data.

Source

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

Creates user audio content from unencoded bytes.

Source

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

Creates user audio content referencing a URL.

Source

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

Creates user video content from base64-encoded data.

Source

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

Creates user video content from unencoded bytes.

Source

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

Creates user video content referencing a URL.

Source

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

Creates user document content from unencoded bytes.

Source

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

Creates user document content referencing a URL.

Source

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

Creates document content from a string without decoding or fetching it.

Source

pub fn tool_result( call: CallId, name: ToolName, content: Vec<ToolResultContent>, ) -> UserContent

Creates a tool result answering the call call to the tool name.

Trait Implementations§

Source§

impl Clone for UserContent

Source§

fn clone(&self) -> UserContent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UserContent

Source§

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

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

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

Source§

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

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

impl From<String> for UserContent

Source§

fn from(text: String) -> UserContent

Converts to this type from the input type.
Source§

impl From<UserContent> for Message

Source§

fn from(content: UserContent) -> Message

Converts to this type from the input type.
Source§

impl PartialEq for UserContent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for UserContent

Source§

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

impl StructuralPartialEq for UserContent

Source§

impl TryFrom<UserContent> for Part

Source§

type Error = MessageError

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

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

Performs the conversion.
Source§

impl TryFrom<UserContent> for Content

Source§

type Error = MessageError

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

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

Performs the conversion.
Source§

impl TryFrom<UserContent> for UserContent

Source§

type Error = MessageError

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

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

Performs the conversion.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more