Enum ChatCompletionRequestMessage

pub enum ChatCompletionRequestMessage {
    System(ChatCompletionSystemMessage),
    User(ChatCompletionUserMessage),
    Assistant(ChatCompletionAssistantMessage),
    Tool(ChatCompletionToolMessage),
}

Message for comprising the conversation.

Variants

System(ChatCompletionSystemMessage)

User(ChatCompletionUserMessage)

Assistant(ChatCompletionAssistantMessage)

Tool(ChatCompletionToolMessage)

Implementations

impl ChatCompletionRequestMessage

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

Creates a new system message.

Arguments

• content - The contents of the system message.

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

pub fn new_user_message( content: ChatCompletionUserMessageContent, name: Option<String>, ) -> Self

Creates a new user message.

Arguments

• content - The contents of the user message.

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

pub fn new_assistant_message( content: Option<String>, name: Option<String>, tool_calls: Option<Vec<ToolCall>>, ) -> Self

Creates a new assistant message.

Arguments

• content - The contents of the assistant message. Required unless tool_calls is specified.

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

• tool_calls - The tool calls generated by the model.

pub fn new_tool_message( content: impl Into<String>, tool_call_id: Option<String>, ) -> Self

Creates a new tool message.

pub fn role(&self) -> ChatCompletionRole

The role of the messages author.

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

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

Trait Implementations

impl Clone for ChatCompletionRequestMessage

fn clone(&self) -> ChatCompletionRequestMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionRequestMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionRequestMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionRequestMessage

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

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

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 ChatCompletionRequestMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ChatCompletionRequestMessage

impl StructuralPartialEq for ChatCompletionRequestMessage