Enum Message 

#[non_exhaustive]
pub enum Message {
    System(SystemMessage),
    User(UserMessage),
    Assistant(AssistantMessage),
    Tool(ToolMessage),
}

A message in an application conversation, tagged by role.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

System(SystemMessage)

Instructions for the model.

User(UserMessage)

Input from the user.

Assistant(AssistantMessage)

Output from the model.

Tool(ToolMessage)

Tool results and approval responses.

Implementations

impl Message

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

A system message.

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

A user message with plain text.

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

A user message with parts.

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

An assistant message with plain text.

pub fn assistant_parts( parts: impl IntoIterator<Item = impl Into<AssistantPart>>, ) -> Self

An assistant message with parts.

pub fn tool(parts: impl IntoIterator<Item = impl Into<ToolPart>>) -> Self

A tool message.

pub fn role(&self) -> Role

The role.

pub fn is_empty(&self) -> bool

Returns true when the message carries no content (empty string or no parts).

pub fn provider_options(&self) -> Option<&ProviderOptions>

Provider-specific options.

pub fn with_provider_options(self, options: ProviderOptions) -> Self

Sets provider-specific options.

pub fn as_system(&self) -> Option<&SystemMessage>

Returns the system message when this is one.

pub fn as_user(&self) -> Option<&UserMessage>

Returns the user message when this is one.

pub fn as_assistant(&self) -> Option<&AssistantMessage>

Returns the assistant message when this is one.

pub fn as_tool(&self) -> Option<&ToolMessage>

Returns the tool message when this is one.

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 From<AssistantMessage> for Message

fn from(message: AssistantMessage) -> Self

Converts to this type from the input type.

impl From<SystemMessage> for Message

fn from(message: SystemMessage) -> Self

Converts to this type from the input type.

impl From<ToolMessage> for Message

fn from(message: ToolMessage) -> Self

Converts to this type from the input type.

impl From<UserMessage> for Message

fn from(message: UserMessage) -> Self

Converts to this type from the input type.

impl PartialEq for Message

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

Equality operator ==.

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

Inequality operator !=.

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