Skip to main content

Message

Struct Message 

Source
pub struct Message {
    pub role: Role,
    pub content: Vec<Content>,
}
Expand description

One turn in a conversation.

Fields§

§role: Role§content: Vec<Content>

Implementations§

Source§

impl Message

Source

pub fn new(role: Role, content: Vec<Content>) -> Message

Source

pub fn system(text: impl Into<String>) -> Message

Source

pub fn user(text: impl Into<String>) -> Message

Source

pub fn assistant(text: impl Into<String>) -> Message

Source

pub fn tool_result( id: impl Into<String>, name: impl Into<String>, output: Json, ) -> Message

The answer from a tool the assistant asked for.

Source

pub fn tool_error( id: impl Into<String>, name: impl Into<String>, message: impl Into<String>, ) -> Message

A tool that failed.

Handed back to the model rather than raised, because a model that hears “that city does not exist” usually corrects itself, and a model that hears nothing at all just hangs the loop.

Source

pub fn with(self, part: Content) -> Message

Source

pub fn text(&self) -> String

Every text part joined, which is what a caller usually means by “what did it say”.

Source

pub fn tool_uses(&self) -> impl Iterator<Item = (&str, &str, &Json)>

The tool requests in this turn, if any.

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Message

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Message

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.