Enum ToolOutput 

pub enum ToolOutput {
    Text {
        text: String,
    },
    Json {
        value: Value,
    },
    Image {
        url: Option<String>,
        path: Option<PathBuf>,
        mime_type: Option<String>,
    },
    File {
        path: PathBuf,
        mime_type: Option<String>,
    },
    Error {
        message: String,
        code: Option<String>,
        retryable: bool,
    },
}

Variants

Text

Fields

text: String

Json

Fields

value: Value

Image

Fields

url: Option<String>

path: Option<PathBuf>

mime_type: Option<String>

File

Fields

path: PathBuf

mime_type: Option<String>

Error

Fields

message: String

code: Option<String>

retryable: bool

Implementations

impl ToolOutput

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

pub fn json(value: Value) -> Self

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

pub fn with_code(self, code: impl Into<String>) -> Self

pub fn retryable(self, retryable: bool) -> Self

pub fn to_result(&self, tool_call_id: impl Into<String>) -> ToolExecutionResult

Trait Implementations

impl Clone for ToolOutput

fn clone(&self) -> ToolOutput

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<'de> Deserialize<'de> for ToolOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolOutput

fn eq(&self, other: &ToolOutput) -> 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 ToolOutput

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 ToolOutput