Enum ChatMessage 

pub enum ChatMessage {
    Developer {
        content: ChatMessageContent,
        name: Option<String>,
    },
    System {
        content: ChatMessageContent,
        name: Option<String>,
    },
    User {
        content: ChatMessageContent,
        name: Option<String>,
    },
    Assistant {
        content: Option<ChatMessageContent>,
        reasoning_content: Option<String>,
        refusal: Option<String>,
        name: Option<String>,
        audio: Option<AudioDataIdParameter>,
        tool_calls: Option<Vec<ToolCall>>,
    },
    Tool {
        content: ChatMessageContent,
        tool_call_id: String,
    },
}

Variants

Developer

Fields

content: ChatMessageContent

The contents of the developer message.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

System

Fields

content: ChatMessageContent

The contents of the system message.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

User

Fields

content: ChatMessageContent

The contents of the user message.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Assistant

Fields

content: Option<ChatMessageContent>

The contents of the assistant message. Required unless tool_calls is specified.

reasoning_content: Option<String>

The reasoning content by the assistant. (DeepSeek API only)

refusal: Option<String>

The refusal message by the assistant.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

audio: Option<AudioDataIdParameter>

Data about a previous audio response from the model.

tool_calls: Option<Vec<ToolCall>>

The tool calls generated by the model, such as function calls.

Tool

Fields

content: ChatMessageContent

The contents of the tool message.

tool_call_id: String

Tool call that this message is responding to.

Implementations

impl ChatMessage

pub fn message(&self) -> Option<&ChatMessageContent>

Get the ChatMessageContent data, if it exists.

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

Get the content of the message as text, if it is a simple text message.

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

Get the name of the message sender, if it exists.

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 PartialEq for ChatMessage

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChatMessage