Struct ToolOutput 

#[non_exhaustive]
pub struct ToolOutput {
    pub parts: Vec<Part>,
}

What a tool sends back to the model: text and media (for example a generated image), in order.

Text converts into it, so a tool that only returns text can keep returning a String. The model gets the text in the tool result and the media in a user message right after the tool results, for every provider for now. A later release puts the media in the tool result itself for the providers that accept it (Anthropic, Gemini, OpenAI Responses, Bedrock and Ollama).

There is no structured (JSON) output: a tool that produces data converts it to text itself, for example with serde_json::to_string, in the format it wants the model to read.

let png = [0x89, b'P', b'N', b'G'];
let output = ToolOutput::from_text("Here is the chart")
    .with_media(Media::from_bytes("image/png", png));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parts: Vec<Part>

Part::Text and Part::Media parts.

Implementations

impl ToolOutput

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

Creates an output with text.

pub fn from_media(media: Media) -> Self

Creates an output with one media part.

pub fn with_text(self, text: impl Into<String>) -> Self

Appends text.

pub fn with_media(self, media: Media) -> Self

Appends media.

pub fn text(&self) -> Option<String>

Returns the text parts joined together, or None when there is no text.

pub fn media(&self) -> Vec<&Media>

Returns the media parts.

Trait Implementations

impl Clone for ToolOutput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolOutput

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

Formats the value using the given formatter.

impl Default for ToolOutput

fn default() -> Self

Returns the “default value” for a type.

impl Display for ToolOutput

Text parts as they are, media as [content type], for example [image/png].

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

Formats the value using the given formatter.

impl From<&str> for ToolOutput

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<Media> for ToolOutput

fn from(media: Media) -> Self

Converts to this type from the input type.

impl From<String> for ToolOutput

fn from(text: String) -> Self

Converts to this type from the input type.

impl PartialEq for ToolOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolOutput