Enum ToolResultContent 

pub enum ToolResultContent {
    Text(Text),
    Image(Image),
    Json {
        value: Value,
    },
}

Describes one typed item in a tool result.

Variants

Text(Text)

Literal text. Providers must not reinterpret it as structured JSON.

Image(Image)

An image supplied explicitly by the tool.

Json

Structured JSON supplied explicitly by the tool runtime.

Fields

value: Value

The structured value.

Implementations

impl ToolResultContent

pub fn as_text(&self) -> Option<&str>

Borrow literal text content.

pub fn as_json(&self) -> Option<&Value>

Borrow structured JSON content.

pub fn deserialize_json<T>(&self) -> Result<T, Error>

where T: DeserializeOwned,

Deserialize JSON content into a typed value.

Structured JSON is decoded directly. Literal text is parsed only because the caller explicitly requested JSON decoding, which supports transcripts recorded before structured tool output was preserved canonically. This helper never changes the content sent to a model or provider.

impl ToolResultContent

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

Helper constructor to make creating tool result text content easier.

pub fn json(value: Value) -> ToolResultContent

Helper constructor for structured JSON tool-result content.

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

Helper constructor to make tool result images from a base64-encoded string.

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

Helper constructor to make tool result images from a base64-encoded string.

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

Helper constructor to make tool result images from a URL.

Trait Implementations

impl Clone for ToolResultContent

fn clone(&self) -> ToolResultContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResultContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResultContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<String> for ToolResultContent

fn from(text: String) -> ToolResultContent

Converts to this type from the input type.

impl From<ToolResultContent> for Message

fn from(tool_result_content: ToolResultContent) -> Message

Converts to this type from the input type.

impl From<ToolResultContent> for ToolResultContent

fn from(content: ToolResultContent) -> ToolResultContent

Converts to this type from the input type.

impl From<ToolResultContent> for ToolOutput

fn from(content: ToolResultContent) -> ToolOutput

Converts to this type from the input type.

impl PartialEq for ToolResultContent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolResultContent

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 ToolResultContent