Enum AgUiMessage 

pub enum AgUiMessage {
    Developer {
        id: MessageId,
        content: String,
        name: Option<String>,
    },
    System {
        id: MessageId,
        content: String,
        name: Option<String>,
    },
    Assistant {
        id: MessageId,
        content: Option<String>,
        name: Option<String>,
        tool_calls: Option<Vec<ToolCall>>,
    },
    User {
        id: MessageId,
        content: String,
        name: Option<String>,
    },
    Tool {
        id: MessageId,
        content: String,
        tool_call_id: ToolCallId,
        error: Option<String>,
    },
    Activity {
        id: MessageId,
        activity_type: String,
        content: Value,
    },
}

Represents the different types of messages in a conversation.

This enum provides a unified type for all message variants, using the role field as the discriminant for JSON serialization.

Variants

Developer

A developer message for debugging.

Fields

id: MessageId

content: String

name: Option<String>

System

A system message (usually the system prompt).

Fields

id: MessageId

content: String

name: Option<String>

Assistant

An assistant message from the AI model.

Fields

id: MessageId

content: Option<String>

name: Option<String>

tool_calls: Option<Vec<ToolCall>>

User

A user message from the human user.

Fields

id: MessageId

content: String

name: Option<String>

Tool

A tool message containing tool call results.

Fields

id: MessageId

content: String

tool_call_id: ToolCallId

error: Option<String>

Activity

An activity message for tracking agent activities.

Fields

id: MessageId

activity_type: String

content: Value

Implementations

impl Message

pub fn new<S>(role: Role, id: impl Into<MessageId>, content: S) -> Message

where S: AsRef<str>,

Creates a new message with the given role, ID, and content.

pub fn new_user<S>(content: S) -> Message

where S: AsRef<str>,

Creates a new user message with a random ID.

pub fn new_tool<S>(content: S) -> Message

where S: AsRef<str>,

Creates a new tool message with a random ID.

pub fn new_system<S>(content: S) -> Message

where S: AsRef<str>,

Creates a new system message with a random ID.

pub fn new_assistant<S>(content: S) -> Message

where S: AsRef<str>,

Creates a new assistant message with a random ID.

pub fn new_developer<S>(content: S) -> Message

where S: AsRef<str>,

Creates a new developer message with a random ID.

pub fn new_activity(activity_type: impl Into<String>, content: Value) -> Message

Creates a new activity message with a random ID.

pub fn id(&self) -> &MessageId

Returns a reference to the message ID.

pub fn id_mut(&mut self) -> &mut MessageId

Returns a mutable reference to the message ID.

pub fn role(&self) -> Role

Returns the role of this message.

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

Returns the content of this message, if any.

Note: Activity messages have JSON content, not string content. Use activity_content() to access their content.

pub fn content_mut(&mut self) -> Option<&mut String>

Returns a mutable reference to the content of this message.

Note: Activity messages have JSON content, not string content. Use activity_content_mut() to modify their content.

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

Returns the activity content of this message, if it’s an activity message.

pub fn activity_content_mut(&mut self) -> Option<&mut Value>

Returns a mutable reference to the activity content, if it’s an activity message.

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

Returns the activity type, if this is an activity message.

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

Returns the tool calls for this message, if any.

pub fn tool_calls_mut(&mut self) -> Option<&mut Vec<ToolCall>>

Returns a mutable reference to the tool calls for this message.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Message