Struct Message

pub struct Message {
    pub role: String,
    pub content: Option<String>,
    pub name: Option<String>,
    pub function_call: Option<FunctionCall>,
}

Fields

role: String

content: Option<String>

name: Option<String>

function_call: Option<FunctionCall>

Implementations

impl Message

pub fn new(role: String) -> Message

pub fn new_user_message(content: String) -> Message

pub fn set_content(&mut self, content: String)

pub fn set_name(&mut self, name: String)

pub fn set_function_call(&mut self, function_call: FunctionCall)

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Message

A message sent by the user or the bot

Print valid JSON for Message, no commas if last field Arguments are escaped to avoid issues with quotes and newlines They break the JSON format and the API doesn’t handle them well

Notes

The API asks for content to be present in the message, even when it’s an assistant message with a function call https://platform.openai.com/docs/api-reference/chat/create

Examples

use chatgpt_functions::message::{FunctionCall, Message};

let mut message = Message::new("role".to_string());
assert_eq!(message.to_string(), "{\"role\":\"role\",\"content\":\"\"}".to_string());

message.set_content("content".to_string());
assert_eq!(
   message.to_string(),
   "{\"role\":\"role\",\"content\":\"content\"}".to_string()
);

message.set_name("name".to_string());
assert_eq!(
   message.to_string(),
   "{\"role\":\"role\",\"content\":\"content\",\"name\":\"name\"}".to_string()
);

message.set_function_call(FunctionCall {
   name: "name".to_string(),
   arguments: "arguments".to_string(),
});
assert_eq!(
   message.to_string(),
   "{\"role\":\"role\",\"content\":\"content\",\"name\":\"name\",\"function_call\":{\"name\":\"name\",\"arguments\":\"arguments\"}}".to_string()
);

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

Formats the value using the given formatter.

impl PartialEq for Message

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

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 Message