Struct ChatMessage 

pub struct ChatMessage {
    pub role: ChatRole,
    pub content: Option<ChatContent>,
    pub name: Option<String>,
    pub tool_call_id: Option<String>,
    pub tool_calls: Option<Vec<Value>>,
}

One message in a chat conversation. Used both in requests and in responses.

Fields

role: ChatRole

content: Option<ChatContent>

name: Option<String>

tool_call_id: Option<String>

tool_calls: Option<Vec<Value>>

Implementations

impl ChatMessage

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

A system prompt.

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

A user turn.

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

An assistant turn.

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

A developer instruction.

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

The result of a tool call, answering tool_call_id.

pub fn user_parts(parts: impl IntoIterator<Item = ChatContentPart>) -> Self

A user turn made of ordered parts, for multimodal input.

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

The message text, when the content is plain text.

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

impl PartialEq for ChatMessage

fn eq(&self, other: &ChatMessage) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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