Skip to main content

Message

Enum Message 

Source
pub enum Message {
    System {
        content: MessageContent,
        name: Option<String>,
    },
    User {
        content: MessageContent,
        name: Option<String>,
    },
    Assistant {
        content: Option<String>,
        audio: Option<AssistantAudio>,
        refusal: Option<String>,
        name: Option<String>,
        prefix: bool,
        reasoning_content: Option<String>,
        tool_calls: Option<Vec<AssistantToolCall>>,
    },
    Tool {
        content: MessageContent,
        tool_call_id: String,
    },
    Function {
        content: String,
        name: String,
    },
    Developer {
        content: MessageContent,
        name: Option<String>,
    },
}

Variants§

§

System

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

Fields

§content: MessageContent

The contents of the system message: plain text, or an array of text content parts.

§name: Option<String>

An optional name for the participant.

Provides the model information to differentiate between participants of the same role.

§

User

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

Fields

§content: MessageContent

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

§name: Option<String>

An optional name for the participant.

Provides the model information to differentiate between participants of the same role.

§

Assistant

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

Fields

§content: Option<String>

The contents of the assistant message. Required unless tool_calls or function_call is specified. (Note that function_call is deprecated in favour of tool_calls.)

§audio: Option<AssistantAudio>

Data about a previous audio response from the model. Required for multi-turn audio conversations.

§refusal: Option<String>

The refusal message by the assistant.

§prefix: bool

DeepSeek (Beta): set this to true to force the model to start its answer by the content of the supplied prefix in this assistant message. Requires base_url = "https://api.deepseek.com/beta".

§reasoning_content: Option<String>

DeepSeek (Beta): used for the thinking mode in the Chat Prefix Completion feature as the input for the CoT in the last assistant message. When using this feature, prefix must be set to true.

§tool_calls: Option<Vec<AssistantToolCall>>

The tool calls generated by the model, such as function calls.

§

Tool

In this case, the role of the message author is assistant. The field { role = "tool" } is added automatically.

Fields

§content: MessageContent

The contents of the tool message: plain text, or an array of text content parts.

§tool_call_id: String

Tool call that this message is responding to.

§

Function

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

Fields

§content: String

The contents of the function message.

§name: String

The name of the function to call.

§

Developer

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

Fields

§content: MessageContent

The contents of the developer message: plain text, or an array of text content parts.

§name: Option<String>

An optional name for the participant.

Provides the model information to differentiate between participants of the same role.

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