Skip to main content

Message

Enum Message 

Source
pub enum Message {
    System(SystemMessage),
    User(UserMessage),
    Assistant(AssistantMessage),
    Tool(ToolMessage),
    Function(FunctionMessage),
    Developer(DeveloperMessage),
}
Expand description

A message in the conversation, tagged by role.

Construct messages through the convenience constructors (Message::system, Message::user, Message::assistant, Message::tool, Message::function, Message::developer) or by building the payload structs directly (Message::User(UserMessage { ..Default::default() })), which stays source-compatible when new optional fields are added.

Deserialization of an unknown role is an error: a message with an unrecognized role cannot be forwarded, so it is treated as invalid input rather than silently mapped onto a catch-all.

Variants§

§

System(SystemMessage)

The role of the message author is system. The field { role = "system" } is added automatically.

§

User(UserMessage)

The role of the message author is user. The field { role = "user" } is added automatically.

§

Assistant(AssistantMessage)

The role of the message author is assistant. The field { role = "assistant" } is added automatically.

§

Tool(ToolMessage)

The role of the message author is tool. The field { role = "tool" } is added automatically.

§

Function(FunctionMessage)

The role of the message author is function. The field { role = "function" } is added automatically.

§

Developer(DeveloperMessage)

The role of the message author is developer. The field { role = "developer" } is added automatically.

Implementations§

Source§

impl Message

Source

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

A system message with the given content: plain text, or an array of text content parts.

Source

pub fn user(content: impl Into<MessageContent>) -> Self

A user message with the given content: plain text, or an array of multimodal content parts (text, image_url, input_audio, file).

Source

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

An assistant message with the given text content. Build AssistantMessage directly for tool calls, audio, or reasoning content.

Source

pub fn tool( content: impl Into<MessageContent>, tool_call_id: impl Into<String>, ) -> Self

A tool message responding to the tool call with the given ID.

Source

pub fn function(name: impl Into<String>, content: impl Into<String>) -> Self

A deprecated function message responding to the named function call.

Source

pub fn developer(content: impl Into<MessageContent>) -> Self

A developer message with the given content: plain text, or an array of text content parts.

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

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

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

Source§

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

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

impl Serialize for Message

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> 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, 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> 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