BaseMessage

Enum BaseMessage 

Source
pub enum BaseMessage {
    Human(HumanMessage),
    System(SystemMessage),
    AI(AIMessage),
    Tool(ToolMessage),
    Chat(ChatMessage),
    Function(FunctionMessage),
    Remove(RemoveMessage),
}
Expand description

A unified message type that can represent any message role.

This corresponds to BaseMessage in LangChain Python.

Variants§

§

Human(HumanMessage)

A human message

§

System(SystemMessage)

A system message

§

AI(AIMessage)

An AI message

§

Tool(ToolMessage)

A tool result message

§

Chat(ChatMessage)

A chat message with arbitrary role

§

Function(FunctionMessage)

A function message (deprecated, use Tool)

§

Remove(RemoveMessage)

A remove message (for message deletion)

Implementations§

Source§

impl BaseMessage

Source

pub fn content(&self) -> &str

Get the message content as a string reference.

For messages with multimodal content, this returns the first text content or an empty string.

Source

pub fn text(&self) -> String

Get the text content of the message as a string.

This extracts text from both simple string content and list content (filtering for text blocks). Corresponds to the text property in Python.

Source

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

Get the message ID.

Source

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

Get the message name if present.

Source

pub fn tool_calls(&self) -> &[ToolCall]

Get tool calls if this is an AI message.

Source

pub fn message_type(&self) -> &'static str

Get the message type as a string.

Source

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

Get additional kwargs if present.

Source

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

Get response metadata if present.

Source

pub fn pretty_print(&self)

Pretty print the message to stdout. This mimics LangChain’s pretty_print() method for messages.

Source

pub fn pretty_repr(&self, html: bool) -> String

Get a pretty representation of the message.

§Arguments
  • html - Whether to format the message with bold text (using ANSI codes). Named html for Python compatibility but actually uses terminal codes.

Trait Implementations§

Source§

impl Clone for BaseMessage

Source§

fn clone(&self) -> BaseMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BaseMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for BaseMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<AIMessage> for BaseMessage

Source§

fn from(msg: AIMessage) -> Self

Converts to this type from the input type.
Source§

impl From<BaseMessage> for StringOrMessage

Source§

fn from(msg: BaseMessage) -> Self

Converts to this type from the input type.
Source§

impl From<ChatMessage> for BaseMessage

Source§

fn from(msg: ChatMessage) -> Self

Converts to this type from the input type.
Source§

impl From<FunctionMessage> for BaseMessage

Source§

fn from(msg: FunctionMessage) -> Self

Converts to this type from the input type.
Source§

impl From<HumanMessage> for BaseMessage

Source§

fn from(msg: HumanMessage) -> Self

Converts to this type from the input type.
Source§

impl From<RemoveMessage> for BaseMessage

Source§

fn from(msg: RemoveMessage) -> Self

Converts to this type from the input type.
Source§

impl From<SystemMessage> for BaseMessage

Source§

fn from(msg: SystemMessage) -> Self

Converts to this type from the input type.
Source§

impl From<ToolMessage> for BaseMessage

Source§

fn from(msg: ToolMessage) -> Self

Converts to this type from the input type.
Source§

impl HasId for BaseMessage

Source§

fn get_id(&self) -> Option<&str>

Get the ID if present.
Source§

impl PartialEq for BaseMessage

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for BaseMessage

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BaseMessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,