Struct FunctionMessage 

pub struct FunctionMessage { /* private fields */ }

A function message in the conversation.

FunctionMessage objects are an older version of the ToolMessage schema, and do not contain the tool_call_id field.

The tool_call_id field is used to associate the tool call request with the tool call response. Useful in situations where a chat model is able to request multiple tool calls in parallel.

This corresponds to FunctionMessage in LangChain Python.

Implementations

impl FunctionMessage

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

Create a new function message.

Arguments

• name - The name of the function that was executed.
• content - The result of the function execution.

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

Create a new function message with an explicit ID.

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

pub fn content(&self) -> &str

Get the message content.

pub fn name(&self) -> &str

Get the function name.

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

Get the message ID.

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

Get additional kwargs.

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

Get response metadata.

pub fn with_response_metadata( self, response_metadata: HashMap<String, Value>, ) -> Self

Set response metadata.

Trait Implementations

impl Clone for FunctionMessage

fn clone(&self) -> FunctionMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FunctionMessage> for BaseMessage

fn from(msg: FunctionMessage) -> Self

Converts to this type from the input type.

impl PartialEq for FunctionMessage

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

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 FunctionMessage