Struct Message

pub struct Message {
    pub role: Role,
    pub content: Vec<MessageContent>,
}

Use MediaMessageBuilder to convert image/document files to a Message instance

Fields

role: Role

content: Vec<MessageContent>

It’s Vec<MessageContent> because a single message may contain multiple contents. There’s no point in [String(s), String(s), ...] because the string contents are concatonated anyway. Multiple contents makes sense when there are images, like [Image { .. }, Image { .. }] or [Image { .. }, String(s), ...].

Message instances constructed from API response are guaranteed to

1. have exactly one content
2. the content is MessageContent::String

Implementations

impl Message

pub fn to_json(&self, api_provider: ApiProvider) -> JsonValue

pub fn from_json(j: &JsonValue) -> Result<Self, Error>

pub fn simple_message(role: Role, message: String) -> Self

pub fn is_valid_system_prompt(&self) -> bool

pub fn is_user_prompt(&self) -> bool

pub fn is_assistant_prompt(&self) -> bool

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 Hash for Message

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 Eq for Message

impl StructuralPartialEq for Message