Struct ToolMessage 

pub struct ToolMessage { /* private fields */ }

A tool message containing the result of a tool call.

ToolMessage objects contain the result of a tool invocation. Typically, the result is encoded inside the content field.

This corresponds to ToolMessage in LangChain Python.

Implementations

impl ToolMessage

pub fn new(content: impl Into<String>, tool_call_id: impl Into<String>) -> Self

Create a new tool message.

pub fn with_id( id: impl Into<String>, content: impl Into<String>, tool_call_id: impl Into<String>, ) -> Self

Create a new tool message with an explicit ID.

Use this when deserializing or reconstructing messages where the ID must be preserved.

pub fn error( content: impl Into<String>, tool_call_id: impl Into<String>, ) -> Self

Create a new tool message with error status.

pub fn with_artifact( content: impl Into<String>, tool_call_id: impl Into<String>, artifact: Value, ) -> Self

Create a new tool message with an artifact.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the name for this tool message.

pub fn content(&self) -> &str

Get the message content.

pub fn tool_call_id(&self) -> &str

Get the tool call ID this message responds to.

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

Get the message ID.

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

Get the tool name.

pub fn status(&self) -> &ToolStatus

Get the status of the tool invocation.

pub fn artifact(&self) -> Option<&Value>

Get the artifact if present.

pub fn additional_kwargs(&self) -> &HashMap<String, Value>

Get additional kwargs.

pub fn response_metadata(&self) -> &HashMap<String, Value>

Get response metadata.

Trait Implementations

impl Clone for ToolMessage

fn clone(&self) -> ToolMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolMessage> for BaseMessage

fn from(msg: ToolMessage) -> Self

Converts to this type from the input type.

impl From<ToolMessage> for ToolOutput

fn from(m: ToolMessage) -> Self

Converts to this type from the input type.

impl PartialEq for ToolMessage

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

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 ToolMessage

impl ToolOutputMixin for ToolMessage