Skip to main content

Message

Struct Message 

Source
pub struct Message {
    pub id: MessageId,
    pub role: MessageRole,
    pub content: Vec<ContentPart>,
    pub phase: Option<ExecutionPhase>,
    pub phase_source: Option<PhaseSource>,
    pub controls: Option<Controls>,
    pub metadata: Option<HashMap<String, Value>>,
    pub external_actor: Option<ExternalActor>,
    pub created_at: DateTime<Utc>,
}
Expand description

A message in the conversation

Fields§

§id: MessageId

Unique message ID (format: message_{32-hex})

§role: MessageRole

Message role

§content: Vec<ContentPart>

Message content as array of content parts (text, images, tool calls, tool results)

§phase: Option<ExecutionPhase>

Execution phase for this message.

Helps LLMs distinguish between intermediate working commentary and completed answers in multi-step tool-calling flows. Only set on agent (assistant) messages. Providers with native phase support (OpenAI GPT-5.x) send this value in the API request; others derive it from state but don’t send it to the provider.

§phase_source: Option<PhaseSource>

Whether Self::phase was reported by the provider or inferred from tool-call presence. A derived phase carries no information beyond “this message called tools”, so consumers that need a real classification must be able to tell the two apart.

§controls: Option<Controls>

Runtime controls (model, reasoning, etc.)

§metadata: Option<HashMap<String, Value>>

Message-level metadata

§external_actor: Option<ExternalActor>

External actor identity (for messages from external channels like Slack)

§created_at: DateTime<Utc>

Timestamp when the message was created

Implementations§

Source§

impl Message

Source

pub fn reasoning_parts(&self) -> impl Iterator<Item = &ReasoningContentPart>

Reasoning artifacts carried by this message, in emission order.

Source

pub fn has_reasoning(&self) -> bool

Whether this message carries any provider reasoning artifact.

Source

pub fn reasoning_display_text(&self) -> Option<String>

Readable reasoning across every artifact, joined for display.

Display only. Replay must walk Message::reasoning_parts so each artifact keeps its own signature and position.

Source

pub fn into_public(self) -> Self

Replace every reasoning part with its publishable projection, dropping opaque provider replay state. Used at API boundaries.

Source

pub fn with_id(self, id: MessageId) -> Self

Override the generated message id.

Streaming producers use this to allocate a public id before emitting output.message.started, then reuse it on the completed message.

Source

pub fn user(content: impl Into<String>) -> Self

Create a new user message

Source

pub fn assistant(content: impl Into<String>) -> Self

Create a new assistant message

Source

pub fn assistant_with_tools( content: impl Into<String>, tool_calls: Vec<ToolCall>, ) -> Self

Create a new assistant message with tool calls

Tool calls are stored as ContentPart::ToolCall in the content array alongside the text content. Empty text content is omitted to avoid LLM API errors (e.g., Anthropic requires non-empty text blocks).

Source

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

Create a new system message

Source

pub fn tool_result( tool_call_id: impl Into<String>, result: Option<Value>, error: Option<String>, ) -> Self

Create a tool result message

Source

pub fn tool_result_with_images( tool_call_id: impl Into<String>, result: Option<Value>, images: Vec<ToolResultImage>, ) -> Self

Create a tool result message with images.

Images are included as ContentPart::Image alongside the ToolResult part. When converted to LlmMessage, images become native image content blocks that the LLM can see visually (not just stringified base64).

Source

pub fn with_phase(self, phase: ExecutionPhase) -> Self

Set the execution phase on this message and return self.

Source

pub fn with_phase_from(self, phase: ExecutionPhase, source: PhaseSource) -> Self

Set the phase together with where it came from.

Source

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

Get the tool_call_id from a tool result message

Returns the tool_call_id from the first ToolResult content part, if any.

Source

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

Get first text content from the message

Source

pub fn tool_calls(&self) -> Vec<&ToolCallContentPart>

Get all tool calls from the message content

Source

pub fn has_tool_calls(&self) -> bool

Check if this message has tool calls

Source

pub fn tool_result_content(&self) -> Option<&ToolResultContentPart>

Get the first tool result from the message content

Source

pub fn content_to_llm_string(&self) -> String

Convert content to LLM-compatible string representation

Source

pub fn to_openai_format(&self) -> Value

Convert message to OpenAI-compatible format

Transforms internal message format to OpenAI API format:

  • agent role → assistant
  • tool_result role → tool (with tool_call_id at message level)
  • Tool calls formatted as {id, type: "function", function: {name, arguments}}

Used by observability backends (e.g., Braintrust) that expect OpenAI format.

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

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

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

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 Serialize for Message

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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