Enum Message 

#[non_exhaustive]
pub enum Message {
    Human {
        id: Option<String>,
        name: Option<String>,
        content: MessageContent,
        additional_kwargs: HashMap<String, Value>,
    },
    AI {
        id: Option<String>,
        name: Option<String>,
        content: MessageContent,
        tool_calls: Vec<ToolCall>,
        invalid_tool_calls: Vec<InvalidToolCall>,
        usage: Option<UsageMetadata>,
        response_metadata: Option<HashMap<String, Value>>,
        additional_kwargs: HashMap<String, Value>,
    },
    System {
        id: Option<String>,
        name: Option<String>,
        content: MessageContent,
        additional_kwargs: HashMap<String, Value>,
    },
    Tool {
        id: Option<String>,
        name: Option<String>,
        content: MessageContent,
        tool_call_id: String,
        status: ToolStatus,
        artifact: Option<Value>,
        additional_kwargs: HashMap<String, Value>,
    },
    Chat {
        id: Option<String>,
        name: Option<String>,
        role: String,
        content: MessageContent,
        additional_kwargs: HashMap<String, Value>,
    },
}

A single unit of conversation.

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.

Human

A human message.

Fields

id: Option<String>

Unique message identifier.

name: Option<String>

Optional sender name.

content: MessageContent

Message content.

additional_kwargs: HashMap<String, Value>

Additional provider-specific kwargs.

AI

An AI message.

Fields

id: Option<String>

Unique message identifier.

name: Option<String>

Optional sender name.

content: MessageContent

Message content.

tool_calls: Vec<ToolCall>

Tool calls made by the model.

invalid_tool_calls: Vec<InvalidToolCall>

Invalid tool calls attempted by the model.

usage: Option<UsageMetadata>

Token usage statistics.

response_metadata: Option<HashMap<String, Value>>

Provider-specific response metadata.

additional_kwargs: HashMap<String, Value>

Additional provider-specific kwargs.

System

A system message.

Fields

id: Option<String>

Unique message identifier.

name: Option<String>

Optional sender name.

content: MessageContent

Message content.

additional_kwargs: HashMap<String, Value>

Additional provider-specific kwargs.

Tool

A tool response message.

Fields

id: Option<String>

Unique message identifier.

name: Option<String>

Optional sender name.

content: MessageContent

Message content.

tool_call_id: String

The ID of the tool call this responds to.

status: ToolStatus

Tool execution status.

artifact: Option<Value>

Rich tool output not sent to the model.

additional_kwargs: HashMap<String, Value>

Additional provider-specific kwargs.

Chat

A generic chat message with custom role.

Fields

id: Option<String>

Unique message identifier.

name: Option<String>

Optional sender name.

role: String

Arbitrary role string.

content: MessageContent

Message content.

additional_kwargs: HashMap<String, Value>

Additional provider-specific kwargs.

Implementations

impl Message

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

Creates a new human message from text.

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

Creates a new AI message from text.

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

Creates a new system message from text.

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

Creates a new tool message.

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

Returns the message ID, if set.

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

Returns the sender name, if set.

pub const fn content(&self) -> &MessageContent

Returns the content of the message.

pub const fn message_type(&self) -> &str

Returns the message type as a string.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MessageLike for Message

fn to_message(&self) -> Message

Convert to a Message.

impl Serialize for Message

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

where __S: Serializer,

Serialize this value into the given Serde serializer.