Enum ToolOutput

#[non_exhaustive]
pub enum ToolOutput {
    Text(String),
    FeedbackRequired(Option<Value>),
    Fail(String),
    Stop,
}

Output of a ToolCall which will be added as a message for the agent to use.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text(String)

Adds the result of the toolcall to messages

FeedbackRequired(Option<Value>)

Indicates that the toolcall requires feedback, i.e. in a human-in-the-loop

Fail(String)

Indicates that the toolcall failed, but can be handled by the llm

Stop

Stops an agent

Implementations

impl ToolOutput

pub const fn is_text(&self) -> bool

Returns true if the enum is ToolOutput::Text otherwise false

pub const fn is_feedback_required(&self) -> bool

Returns true if the enum is ToolOutput::FeedbackRequired otherwise false

pub const fn is_fail(&self) -> bool

Returns true if the enum is ToolOutput::Fail otherwise false

pub const fn is_stop(&self) -> bool

Returns true if the enum is ToolOutput::Stop otherwise false

impl ToolOutput

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

pub fn feedback_required(feedback: Option<Value>) -> Self

pub fn stop() -> Self

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

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

Trait Implementations

impl Clone for ToolOutput

fn clone(&self) -> ToolOutput

Returns a duplicate of the value.

const 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 Display for ToolOutput

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

Formats the value using the given formatter.

impl<T: AsRef<str>> From<T> for ToolOutput

fn from(s: T) -> Self

Converts to this type from the input type.

impl PartialEq for ToolOutput

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

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

const 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