Enum Message 

pub enum Message {
    System {
        content: String,
    },
    User {
        content: OneOrMany<UserContent>,
    },
    Assistant {
        id: Option<String>,
        content: OneOrMany<AssistantContent>,
    },
}

A provider-agnostic chat message.

Messages are role-tagged and may contain one or many content items, including text, images, audio, documents, tool calls, and tool results. Provider modules are responsible for translating these generic messages into provider-native request bodies. That conversion may be lossy when a provider does not support a particular content type.

Variants

System

System message containing instruction text.

Fields

content: String

User

User message containing one or more content types defined by UserContent.

Fields

content: OneOrMany<UserContent>

Assistant

Assistant message containing one or more content types defined by AssistantContent.

Fields

id: Option<String>

Provider-assigned assistant message ID, when available.

content: OneOrMany<AssistantContent>

Implementations

impl Message

pub fn rag_text(&self) -> Option<String>

This helper method is primarily used to extract the first string prompt from a Message. Since Message might have more than just text content, we need to find the first text.

pub fn system(text: impl Into<String>) -> Message

Helper constructor to make creating system messages easier.

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

Helper constructor to make creating user messages easier.

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

Helper constructor to make creating assistant messages easier.

pub fn assistant_with_id(id: String, text: impl Into<String>) -> Message

Helper constructor to make creating assistant messages easier.

pub fn tool_result(id: impl Into<String>, content: impl Into<String>) -> Message

Helper constructor to make creating tool result messages easier.

pub fn tool_result_with_call_id( id: impl Into<String>, call_id: Option<String>, content: impl Into<String>, ) -> Message

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Message, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Message> for Message

fn from(msg: &Message) -> Message

Converts to this type from the input type.

impl From<&String> for Message

fn from(text: &String) -> Message

Converts to this type from the input type.

impl From<&str> for Message

fn from(text: &str) -> Message

Converts to this type from the input type.

impl From<AssistantContent> for Message

fn from(content: AssistantContent) -> Message

Converts to this type from the input type.

impl From<Audio> for Message

fn from(audio: Audio) -> Message

Converts to this type from the input type.

impl From<Document> for Message

fn from(document: Document) -> Message

Converts to this type from the input type.

impl From<Image> for Message

fn from(image: Image) -> Message

Converts to this type from the input type.

impl From<Message> for Message

Conversion from provider Message to a completion message. This is needed so that responses can be converted back into chat history.

fn from(msg: Message) -> Message

Converts to this type from the input type.

impl From<OneOrMany<AssistantContent>> for Message

fn from(content: OneOrMany<AssistantContent>) -> Message

Converts to this type from the input type.

impl From<OneOrMany<UserContent>> for Message

fn from(content: OneOrMany<UserContent>) -> Message

Converts to this type from the input type.

impl From<String> for Message

fn from(text: String) -> Message

Converts to this type from the input type.

impl From<Text> for Message

fn from(text: Text) -> Message

Converts to this type from the input type.

impl From<ToolCall> for Message

fn from(tool_call: ToolCall) -> Message

Converts to this type from the input type.

impl From<ToolResult> for Message

fn from(tool_result: ToolResult) -> Message

Converts to this type from the input type.

impl From<ToolResultContent> for Message

fn from(tool_result_content: ToolResultContent) -> Message

Converts to this type from the input type.

impl From<UserContent> for Message

fn from(content: UserContent) -> Message

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Message

impl TryFrom<Message> for Message

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Message

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Vec<Message>

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( message: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Message

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Content

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( msg: Message, ) -> Result<Content, <Content as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Step

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from(message: Message) -> Result<Step, <Step as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Vec<Message>

Conversion from an internal Rig message (crate::message::Message) to a provider Message. (Only User and Assistant variants are supported.)

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( internal_msg: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Vec<Message>

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( message: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Message

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( message: Message, ) -> Result<Message, <Message as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Vec<InputItem>

type Error = CompletionError

The type returned in the event of a conversion error.

fn try_from( value: Message, ) -> Result<Vec<InputItem>, <Vec<InputItem> as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Vec<Message>

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from( message: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<Message> for Vec<Message>

type Error = CompletionError

The type returned in the event of a conversion error.

fn try_from( msg: Message, ) -> Result<Vec<Message>, <Vec<Message> as TryFrom<Message>>::Error>

Performs the conversion.

impl TryFrom<RawMessage> for Message

type Error = CompletionError

The type returned in the event of a conversion error.

fn try_from( raw: RawMessage, ) -> Result<Message, <Message as TryFrom<RawMessage>>::Error>

Performs the conversion.