Struct ChatCompletionMessage

pub struct ChatCompletionMessage {
    pub role: ChatCompletionMessageRole,
    pub content: Option<String>,
    pub name: Option<String>,
    pub function_call: Option<ChatCompletionFunctionCall>,
    pub tool_call_id: Option<String>,
    pub tool_calls: Option<Vec<ToolCall>>,
}

Fields

role: ChatCompletionMessageRole

The role of the author of this message.

content: Option<String>

The contents of the message

This is always required for all messages, except for when ChatGPT calls a function.

name: Option<String>

The name of the user in a multi-user chat

function_call: Option<ChatCompletionFunctionCall>

The function that ChatGPT called. This should be “None” usually, and is returned by ChatGPT and not provided by the developer

API Reference

tool_call_id: Option<String>

Tool call that this message is responding to. Required if the role is Tool.

tool_calls: Option<Vec<ToolCall>>

Tool calls that the assistant is requesting to invoke. Can only be populated if the role is Assistant, otherwise it should be empty.

Trait Implementations

impl Clone for ChatCompletionMessage

fn clone(&self) -> ChatCompletionMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionMessage

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

Formats the value using the given formatter.

impl Default for ChatCompletionMessage

fn default() -> ChatCompletionMessage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChatCompletionMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionMessage

fn eq(&self, other: &ChatCompletionMessage) -> 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 ChatCompletionMessage

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 ChatCompletionMessage

impl StructuralPartialEq for ChatCompletionMessage