Struct SystemMessage

pub struct SystemMessage {
    pub content: MessageContent,
    pub additional_kwargs: HashMap<String, Value>,
    pub response_metadata: HashMap<String, Value>,
    pub name: Option<String>,
    pub id: Option<String>,
}

System message

Fields

content: MessageContent

The content of the message

additional_kwargs: HashMap<String, Value>

Additional keyword arguments

response_metadata: HashMap<String, Value>

Response metadata

name: Option<String>

Optional name for the message

id: Option<String>

Optional unique identifier

Implementations

impl SystemMessage

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

Create a new system message with text content

Trait Implementations

impl BaseMessage for SystemMessage

fn content(&self) -> &MessageContent

Get the content of the message

fn message_type(&self) -> &str

Get the message type

fn additional_kwargs(&self) -> &HashMap<String, Value>

Get additional kwargs

fn response_metadata(&self) -> &HashMap<String, Value>

Get response metadata

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

Get the message name

fn id(&self) -> Option<&str>

Get the message ID

fn text(&self) -> String

Convert the message content to text

fn is_human(&self) -> bool

Check if this is a human message

fn is_ai(&self) -> bool

Check if this is an AI message

fn is_system(&self) -> bool

Check if this is a system message

fn is_tool(&self) -> bool

Check if this is a tool message

impl Clone for SystemMessage

fn clone(&self) -> SystemMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SystemMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SystemMessage

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

fn namespace() -> Vec<String>

Get the namespace for this serializable object

fn is_serializable() -> bool

Check if this object is serializable

fn to_json(&self) -> Result<String>

Serialize this object to JSON

fn to_json_pretty(&self) -> Result<String>

Serialize this object to a pretty-printed JSON string

fn from_json(json: &str) -> Result<Self>

where Self: Sized,

Deserialize this object from JSON

fn to_dict(&self) -> Result<HashMap<String, Value>>

Serialize this object to a dictionary (HashMap)

fn from_dict(dict: &HashMap<String, Value>) -> Result<Self>

where Self: Sized,

Deserialize this object from a dictionary (HashMap)

fn type_name() -> &'static str

Get the type name for this serializable object

impl Serialize for SystemMessage

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 SystemMessage