Enum Message 

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

A message represents a run of input (user) and output (assistant). Each message type (based on it’s role) can contain a atleast one bit of content such as text, images, audio, documents, or tool related information. While each message type can contain multiple content, most often, you’ll only see one content type per message (an image w/ a description, etc).

Each provider is responsible with converting the generic message into it’s provider specific type using From or TryFrom traits. Since not every provider supports every feature, the conversion can be lossy (providing an image might be discarded for a non-image supporting provider) though the message being converted back and forth should always be the same.

Variants

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>

content: OneOrMany<AssistantContent>

Implementations

impl Message

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

Helper constructor to make creating user messages easier.

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

Helper constructor to make creating assistant messages easier.

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

Helper constructor to make creating assistant messages easier.

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

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>, ) -> Self

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<&String> for Message

fn from(text: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Message

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<AssistantContent> for Message

fn from(content: AssistantContent) -> Self

Converts to this type from the input type.

impl From<Audio> for Message

fn from(audio: Audio) -> Self

Converts to this type from the input type.

impl From<Document> for Message

fn from(document: Document) -> Self

Converts to this type from the input type.

impl From<Image> for Message

fn from(image: Image) -> Self

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) -> Self

Converts to this type from the input type.

impl From<Message> for Message

fn from(message: Message) -> Self

Converts to this type from the input type.

impl From<Message> for Value

fn from(msg: Message) -> Self

Converts to this type from the input type.

impl From<OneOrMany<AssistantContent>> for Message

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

Converts to this type from the input type.

impl From<OneOrMany<UserContent>> for Message

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

Converts to this type from the input type.

impl From<String> for Message

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Text> for Message

fn from(text: Text) -> Self

Converts to this type from the input type.

impl From<ToolCall> for Message

fn from(tool_call: ToolCall) -> Self

Converts to this type from the input type.

impl From<ToolResult> for Message

fn from(tool_result: ToolResult) -> Self

Converts to this type from the input type.

impl From<ToolResultContent> for Message

fn from(tool_result_content: ToolResultContent) -> Self

Converts to this type from the input type.

impl From<UserContent> for Message

fn from(content: UserContent) -> Self

Converts to this type from the input type.

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 TryFrom<Content> for Message

type Error = MessageError

The type returned in the event of a conversion error.

fn try_from(content: Content) -> Result<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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>, Self::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<Self, Self::Error>

Performs the conversion.

impl TryFrom<Message> for Vec<Message>

---

Provider Message Conversions

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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Message

type Error = CompletionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Message