Struct Message

pub struct Message {
    pub author: Author,
    pub recipient: Option<String>,
    pub content: Vec<Content>,
    pub channel: Option<String>,
    pub content_type: Option<String>,
}

Fields

author: Author

An object representing the author of the message, including their role (e.g., user, assistant) and any additional metadata.

recipient: Option<String>

The intended recipient of the message. If not set, the message is is intend for all (this is the default). Can also be set to specific identifiers (e.g., ‘user’, ‘assistant’, etc.) In the case of a tool call, the recipient is the name of the tool.

content: Vec<Content>

The main content of the message. This can be of various types (e.g., text, code) and structures, depending on the type of MessageContent used.

channel: Option<String>

Specifies the target channel (context) for the message, allowing models to annotate their responses and e.g. control message visibility. By default, messages do not have channel set (None) and it’s not rendered. When set and render_channel=True, the channel is rendered in message header as <|channel|>CHANNEL_VALUE (usually, “<|meta_sep|>CHANNEL_VALUE”). To not render channels, use formatter.render_channel = False. (note: parsing will raise an error if render_channel=False, but a channel was sampled).

content_type: Option<String>

Content type of the message. This is typically only set by the model, you probably don’t need to set this.

Implementations

impl Message

pub fn from_author_and_content<C>(author: Author, content: C) -> Self

where C: Into<Content>,

pub fn from_role_and_content<C>(role: Role, content: C) -> Self

where C: Into<Content>,

pub fn from_role_and_contents<I>(role: Role, content: I) -> Self

where I: IntoIterator<Item = Content>,

pub fn adding_content<C>(self, content: C) -> Self

where C: Into<Content>,

pub fn with_channel<S>(self, channel: S) -> Self

where S: Into<String>,

pub fn with_recipient<S>(self, recipient: S) -> Self

where S: Into<String>,

pub fn with_content_type<S>(self, content_type: S) -> Self

where S: Into<String>,

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

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 Message