Struct ToolReturnValue 

pub struct ToolReturnValue {
    pub is_error: bool,
    pub output: ToolOutput,
    pub message: String,
    pub display: Vec<DisplayBlock>,
    pub extras: Option<Value>,
}

The result of a tool execution.

Fields

is_error: bool

Whether the tool execution failed.

output: ToolOutput

Output returned to the model. Can be plain text or content parts.

message: String

Explanatory message for the model.

display: Vec<DisplayBlock>

Display blocks shown to the user.

extras: Option<Value>

Extra debug info.

Implementations

impl ToolReturnValue

pub fn new(message: impl Into<String>) -> Self

Create a successful tool return value.

pub fn with_error(self) -> Self

Mark this return value as an error.

pub fn with_output(self, output: impl Into<ToolOutput>) -> Self

Set the tool output.

pub fn with_display(self, block: DisplayBlock) -> Self

Add a display block.

Trait Implementations

impl Clone for ToolReturnValue

fn clone(&self) -> ToolReturnValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolReturnValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolReturnValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolReturnValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolReturnValue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolReturnValue