Enum ChatMessage

pub enum ChatMessage {
    Developer {
        content: Content,
        name: Option<String>,
    },
    System {
        content: Content,
        name: Option<String>,
    },
    User {
        content: UserContent,
        name: Option<String>,
    },
    Assistant {
        content: Option<AssistantContent>,
        refusal: Option<String>,
        name: Option<String>,
        audio: Option<AssistantAudio>,
        tool_calls: Option<Vec<AssistantToolCall>>,
        function_call: Option<AssistantFunctionCall>,
    },
    Tool {
        content: Content,
        tool_call_id: String,
    },
}

Variants

Developer

Fields

content: Content

The contents of the developer message.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

System

Fields

content: Content

The contents of the developer message.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

User

Fields

content: UserContent

The contents of the user message.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Assistant

Fields

content: Option<AssistantContent>

The contents of the assistant message. Required unless tool_calls or function_call is specified.

refusal: Option<String>

The refusal message by the assistant.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

audio: Option<AssistantAudio>

Data about a previous audio response from the model. Learn more.

tool_calls: Option<Vec<AssistantToolCall>>

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

function_call: Option<AssistantFunctionCall>

👎Deprecated

Deprecated and replaced by tool_calls. The name and arguments of a function that should be called, as generated by the model.

Tool

Fields

content: Content

The contents of the tool message.

tool_call_id: String

Tool call that this message is responding to.

Implementations

impl ChatMessage

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

impl ChatMessage

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

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

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

pub fn user_image(image_url: impl Into<ImageUrl>) -> Self

pub fn user_image_with_text( text: impl Into<String>, image_url: impl Into<ImageUrl>, ) -> Self

pub fn user_parts(parts: Vec<UserContentPart>) -> Self

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

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

Trait Implementations

impl Clone for ChatMessage

fn clone(&self) -> ChatMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatMessage

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

Tests for self and other values to be equal, and is used by ==.

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

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 ChatMessage