llm_chain::prompt

Struct ChatMessage

pub struct ChatMessage<Body> { /* private fields */ }

Expand description

The ChatMessage struct represents a chat message. It has two fields:

role: The role of the message sender.
body: The body of the message.

Implementations§

impl<Body> ChatMessage<Body>

pub fn new(role: ChatRole, body: Body) -> Self

Creates a new chat message.

§Arguments

role - The role of the message sender.
body - The body of the message.

pub fn assistant(body: Body) -> Self

Creates a new chat message with the role of Assistant.

§Arguments

body - The body of the message.

§Example

use llm_chain::prompt::{ChatMessage, ChatRole};
let msg = ChatMessage::assistant("Hello, how can I help you?");

assert_eq!(msg.role(), &ChatRole::Assistant);

pub fn user(body: Body) -> Self

Creates a new chat message with the role of User.

§Arguments

body - The body of the message.

§Example

use llm_chain::prompt::{ChatMessage, ChatRole};
let msg = ChatMessage::user("What's the weather like today?");

assert_eq!(msg.role(), &ChatRole::User);

pub fn system(body: Body) -> Self

Creates a new chat message with the role of System.

§Arguments

body - The body of the message.

§Example

use llm_chain::prompt::{ChatMessage, ChatRole};
let msg = ChatMessage::system("Session started.");

assert_eq!(msg.role(), &ChatRole::System);

pub fn map<U, F: FnOnce(&Body) -> U>(&self, f: F) -> ChatMessage<U>

Maps the body of the chat message using the provided function f.

§Arguments

f - The function to apply to the message body.

§Example

use llm_chain::prompt::{ChatMessage, ChatRole};
let msg = ChatMessage::new(ChatRole::Assistant, "Hello!");
let mapped_msg = msg.map(|body| body.to_uppercase());

assert_eq!(mapped_msg.body(), "HELLO!");

pub fn try_map<U, E, F: Fn(&Body) -> Result<U, E>>( &self, f: F, ) -> Result<ChatMessage<U>, E>

Applies a fallible function f to the body of the chat message and returns a new chat message with the mapped body or an error if the function fails.

§Arguments

f - The fallible function to apply to the message body.

pub fn role(&self) -> &ChatRole

Returns a reference to the role of the message sender.

pub fn body(&self) -> &Body

Returns a reference to the body of the message.

Trait Implementations§

impl<Body: Clone> Clone for ChatMessage<Body>

fn clone(&self) -> ChatMessage<Body>

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<Body: Debug> Debug for ChatMessage<Body>

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

Formats the value using the given formatter. Read more

impl<'de, Body> Deserialize<'de> for ChatMessage<Body>
where Body: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<T: Display> Display for ChatMessage<T>

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

Formats the value using the given formatter. Read more

impl<T> From<ChatMessage<T>> for Data<T>

fn from(chat: ChatMessage<T>) -> Self

Converts to this type from the input type.

impl<Body> Serialize for ChatMessage<Body>
where Body: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl<Body> Freeze for ChatMessage<Body>
where Body: Freeze,

impl<Body> RefUnwindSafe for ChatMessage<Body>
where Body: RefUnwindSafe,

impl<Body> Send for ChatMessage<Body>
where Body: Send,

impl<Body> Sync for ChatMessage<Body>
where Body: Sync,

impl<Body> Unpin for ChatMessage<Body>
where Body: Unpin,

impl<Body> UnwindSafe for ChatMessage<Body>
where Body: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,