Enum Message 

pub enum Message {
    System {
        content: String,
    },
    User {
        content: Vec<UserContent>,
    },
    Assistant(AssistantMessage),
}

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: Vec<UserContent>

Assistant(AssistantMessage)

An assistant turn: its blocks in the order the provider produced them, and where they came from.

Implementations

impl Message

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

Clones the first text block of a user message, or returns None.

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

Creates a system instruction message.

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

Creates a user message containing one text block.

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

Creates a hand-built assistant message containing one text block.

pub fn tool_result( call: CallId, name: ToolName, content: impl Into<String>, ) -> Self

Creates a user message containing a text tool result answering the call call to the tool name. To answer a call you hold, prefer ToolCall::result with Self::tool_results.

pub fn tool_results(results: Vec<ToolResult>) -> Self

Creates a user message carrying results, in order.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Self

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

fn from(msg: &Message) -> Self

Converts to this type from the input type.

impl From<&String> for Message

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Message

fn from(value: &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<AssistantMessage> for Message

fn from(message: AssistantMessage) -> Self

Converts to this type from the input type.

impl From<Audio> for Message

fn from(value: Audio) -> Self

Converts to this type from the input type.

impl From<Document> for Message

fn from(value: Document) -> Self

Converts to this type from the input type.

impl From<Image> for Message

fn from(value: Image) -> Self

Converts to this type from the input type.

impl From<Message> for CompletionRequest

fn from(prompt: Message) -> Self

Converts to this type from the input type.

impl From<String> for Message

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Text> for Message

fn from(value: Text) -> Self

Converts to this type from the input type.

impl From<ToolCall> for Message

fn from(value: ToolCall) -> Self

Converts to this type from the input type.

impl From<ToolResult> for Message

fn from(value: ToolResult) -> 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 From<Vec<AssistantContent>> for Message

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

Converts to this type from the input type.

impl From<Vec<UserContent>> for Message

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

Converts to this type from the input type.

impl PartialEq for Message

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