Skip to main content

Message

Enum Message 

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

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§

Source§

impl Message

Source

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

The text of a final answer: the text parts of the model’s message, joined by blank lines and trimmed. None when this is not the model’s message, still asks for tool calls, or has no text.

use rig_core::message::Message;

assert_eq!(Message::assistant(" Done. ").final_answer().as_deref(), Some("Done."));
assert_eq!(Message::user("Done.").final_answer(), None);
Source

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

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

Source

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

Creates a system instruction message.

Source

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

Creates a user message containing one text block.

Source

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

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

Source

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

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.

Source

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

Creates a user message carrying results, in order.

Source

pub fn images(&self) -> impl Iterator<Item = &Image>

The images of this message, in order: a user message’s own and those of its tool results, or an assistant turn’s.

Source

pub fn images_mut(&mut self) -> impl Iterator<Item = &mut Image>

The images of this message, as Self::images, to change in place.

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&Message> for Message

Source§

fn from(msg: &Message) -> Message

Converts to this type from the input type.
Source§

impl From<&String> for Message

Source§

fn from(value: &String) -> Message

Converts to this type from the input type.
Source§

impl From<&str> for Message

Source§

fn from(value: &str) -> Message

Converts to this type from the input type.
Source§

impl From<Arc<Message>> for Message

A shared message, such as a conversation’s, taken out of its Arc: moved when nothing else holds it, else copied.

Source§

fn from(msg: Arc<Message>) -> Message

Converts to this type from the input type.
Source§

impl From<AssistantContent> for Message

Source§

fn from(content: AssistantContent) -> Message

Converts to this type from the input type.
Source§

impl From<AssistantMessage> for Message

Source§

fn from(message: AssistantMessage) -> Message

Converts to this type from the input type.
Source§

impl From<Audio> for Message

Source§

fn from(value: Audio) -> Message

Converts to this type from the input type.
Source§

impl From<Document> for Message

Source§

fn from(value: Document) -> Message

Converts to this type from the input type.
Source§

impl From<Image> for Message

Source§

fn from(value: Image) -> Message

Converts to this type from the input type.
Source§

impl From<Message> for CompletionRequest

Source§

fn from(prompt: Message) -> CompletionRequest

Converts to this type from the input type.
Source§

impl From<String> for Message

Source§

fn from(value: String) -> Message

Converts to this type from the input type.
Source§

impl From<Text> for Message

Source§

fn from(value: Text) -> Message

Converts to this type from the input type.
Source§

impl From<ToolCall> for Message

Source§

fn from(value: ToolCall) -> Message

Converts to this type from the input type.
Source§

impl From<ToolResult> for Message

Source§

fn from(value: ToolResult) -> Message

Converts to this type from the input type.
Source§

impl From<UserContent> for Message

Source§

fn from(content: UserContent) -> Message

Converts to this type from the input type.
Source§

impl From<Vec<AssistantContent>> for Message

Source§

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

Converts to this type from the input type.
Source§

impl From<Vec<UserContent>> for Message

Source§

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

Converts to this type from the input type.
Source§

impl PartialEq for Message

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Message

Source§

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. Read more
Source§

impl StructuralPartialEq for Message

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more