Struct ChatMessage 

pub struct ChatMessage {
    pub role: Role,
    pub content: MessageContent,
    pub audio: Option<AudioOutput>,
    pub tool_calls: Option<Vec<ToolCall>>,
    pub tool_call_id: Option<String>,
}

A single message in a conversation thread.

Fields

role: Role

content: MessageContent

Text or multipart content. Deserialised as empty string when the provider returns null (e.g. GPT-4o audio-only responses).

audio: Option<AudioOutput>

Audio output, present only when a model produces audio (e.g. GPT-4o with modalities: ["audio"]).

tool_calls: Option<Vec<ToolCall>>

Tool calls requested by the model in an assistant message.

tool_call_id: Option<String>

Tool call ID this message is responding to (used in Role::Tool messages).

Implementations

impl ChatMessage

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

Create a system message.

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

Create a user text message.

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

Create an assistant text message.

pub fn tool_result( tool_call_id: impl Into<String>, content: impl Into<String>, ) -> Self

Create a tool result message to send back after a model requested a tool call.

tool_call_id must match the ToolCall::id from the assistant message. content is the serialised result of calling the function.

pub fn user_with_image( text: impl Into<String>, image_url: impl Into<String>, ) -> Self

Create a user message containing text followed by a single image.

image_url can be an HTTPS URL or a data:image/...;base64,... URL.

pub fn with_parts(role: Role, parts: Vec<ContentPart>) -> Self

Create a message with arbitrary content parts.

Trait Implementations

impl Clone for ChatMessage

fn clone(&self) -> ChatMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.