Struct ToolOutput 

pub struct ToolOutput {
    pub content: String,
    pub failure: Option<ToolFailure>,
    pub truncated: bool,
}

A tool’s result as the model sees it. A failure is still a result: the model reads it and can react.

Fields

content: String

failure: Option<ToolFailure>

Why the call failed; None when it succeeded.

truncated: bool

Implementations

impl ToolOutput

pub fn success(content: impl Into<String>) -> Self

pub fn failed(failure: ToolFailure, content: impl Into<String>) -> Self

A failed result whose content tells the model why.

pub fn is_error(&self) -> bool

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 Eq for ToolOutput

impl From<ToolError> for ToolOutput

fn from(error: ToolError) -> Self

The failed result the model sees for a call that could not run.

impl PartialEq for ToolOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolOutput