Struct Message 

pub struct Message {
    pub id: Option<String>,
    pub role: Role,
    pub created: i64,
    pub content: Vec<MessageContent>,
    pub metadata: MessageMetadata,
}

A message to or from an LLM

Fields

id: Option<String>

role: Role

created: i64

content: Vec<MessageContent>

metadata: MessageMetadata

Implementations

impl Message

pub fn new(role: Role, created: i64, content: Vec<MessageContent>) -> Self

pub fn debug(&self) -> String

pub fn user() -> Self

Create a new user message with the current timestamp

pub fn assistant() -> Self

Create a new assistant message with the current timestamp

pub fn with_id<S: Into<String>>(self, id: S) -> Self

pub fn with_content(self, content: MessageContent) -> Self

Add any MessageContent to the message

pub fn with_text<S: Into<String>>(self, text: S) -> Self

Add text content to the message

pub fn with_image<S: Into<String>, T: Into<String>>( self, data: S, mime_type: T, ) -> Self

Add image content to the message

pub fn with_tool_request<S: Into<String>>( self, id: S, tool_call: ToolResult<CallToolRequestParam>, ) -> Self

Add a tool request to the message

pub fn with_tool_request_with_metadata<S: Into<String>>( self, id: S, tool_call: ToolResult<CallToolRequestParam>, metadata: Option<&ProviderMetadata>, tool_meta: Option<Value>, ) -> Self

pub fn with_tool_response<S: Into<String>>( self, id: S, result: ToolResult<CallToolResult>, ) -> Self

Add a tool response to the message

pub fn with_tool_response_with_metadata<S: Into<String>>( self, id: S, result: ToolResult<CallToolResult>, metadata: Option<&ProviderMetadata>, ) -> Self

pub fn with_action_required<S: Into<String>>( self, id: S, tool_name: String, arguments: JsonObject, prompt: Option<String>, ) -> Self

Add an action required message for tool confirmation

pub fn with_frontend_tool_request<S: Into<String>>( self, id: S, tool_call: ToolResult<CallToolRequestParam>, ) -> Self

pub fn with_thinking<S1: Into<String>, S2: Into<String>>( self, thinking: S1, signature: S2, ) -> Self

Add thinking content to the message

pub fn with_redacted_thinking<S: Into<String>>(self, data: S) -> Self

Add redacted thinking content to the message

pub fn as_concat_text(&self) -> String

Get the concatenated text content of the message, separated by newlines

pub fn is_tool_call(&self) -> bool

Check if the message is a tool call

pub fn is_tool_response(&self) -> bool

Check if the message is a tool response

pub fn get_tool_ids(&self) -> HashSet<&str>

Retrieves all tool id from the message

pub fn get_tool_request_ids(&self) -> HashSet<&str>

Retrieves all tool id from ToolRequest messages

pub fn get_tool_response_ids(&self) -> HashSet<&str>

Retrieves all tool id from ToolResponse messages

pub fn has_only_text_content(&self) -> bool

Check if the message has only TextContent

pub fn with_system_notification<S: Into<String>>( self, notification_type: SystemNotificationType, msg: S, ) -> Self

pub fn with_visibility(self, user_visible: bool, agent_visible: bool) -> Self

Set the visibility metadata for the message

pub fn with_metadata(self, metadata: MessageMetadata) -> Self

Set the entire metadata for the message

pub fn user_only(self) -> Self

Mark the message as only visible to the user (not the agent)

pub fn agent_only(self) -> Self

Mark the message as only visible to the agent (not the user)

pub fn is_user_visible(&self) -> bool

Check if the message is visible to the user

pub fn is_agent_visible(&self) -> bool

Check if the message is visible to the agent

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 From<PromptMessage> for Message

fn from(prompt_message: PromptMessage) -> Self

Converts to this type from the input type.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for Message

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl StructuralPartialEq for Message