Struct ChatMessageCollection

Source

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

Expand description

A collection of chat messages with various roles (e.g., user, assistant, system).

Implementations§

Source §

impl<Body> ChatMessageCollection<Body>

Source

pub fn new() -> Self

Creates a new empty ChatMessageCollection.

Source

pub fn for_vector(messages: Vec<ChatMessage<Body>>) -> Self

Creates a ChatMessageCollection from a given vector of ChatMessage.

§Arguments

messages - A vector of ChatMessage instances to be included in the collection.

Source

pub fn with_system(self, body: Body) -> Self

Adds a system message to the collection with the given body.

§Arguments

body - The message body to be added as a system message.

Source

pub fn with_user(self, body: Body) -> Self

Adds a user message to the collection with the given body.

§Arguments

body - The message body to be added as a user message.

Source

pub fn with_assistant(self, body: Body) -> Self

Adds an assistant message to the collection with the given body.

§Arguments

body - The message body to be added as an assistant message.

Source

pub fn append(&mut self, other: ChatMessageCollection<Body>)

Appends another ChatMessageCollection to this one

§Arguments

other - The other ChatMessageCollection to append to this one

Source

pub fn add_message(&mut self, message: ChatMessage<Body>)

Appends a ChatMessage to the collection.

§Arguments

message - The ChatMessage instance to be added to the collection.

Source

pub fn remove_first_message(&mut self) -> Option<ChatMessage<Body>>

Removes the first message from the collection and returns it, or None if the collection is empty.

Source

pub fn len(&self) -> usize

Returns the number of messages in the collection.

Source

pub fn is_empty(&self) -> bool

Returns true if the collection contains no messages.

Source

pub fn get_message(&self, index: usize) -> Option<&ChatMessage<Body>>

Returns a reference to the message at the specified index, or None if the index is out of bounds.

§Arguments

index - The index of the desired message in the collection.

Source

pub fn iter(&self) -> Iter<'_, ChatMessage<Body>>

Returns an iterator over the messages in the collection.

Source

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

Creates a new ChatMessageCollection with the results of applying a function to each ChatMessage.

§Arguments

f - The function to apply to each ChatMessage.

Source

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

Creates a new ChatMessageCollection by applying a fallible function to each message body in the current collection. Returns an error if the function fails for any message.

§Arguments

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

Source

pub fn trim_to_max_messages(&mut self, max_number_of_messages: usize)

Trims the conversation to the specified number of messages by removing the oldest messages.

§Arguments

max_number_of_messages - The desired number of messages to keep in the conversation.

Source §

impl ChatMessageCollection<String>

Implementation of ChatMessageCollection for String.

Source

pub fn trim_context<Tok>( &mut self, tokenizer: &Tok, max_tokens: i32, ) -> Result<(), TokenizerError>
where Tok: Tokenizer,

Trims the conversation context by removing the oldest messages in the collection until the total number of tokens in the remaining messages is less than or equal to the specified max_tokens limit.

§Arguments

tokenizer - An instance of a Tokenizer that is used to tokenize the chat message bodies.
max_tokens - The maximum number of tokens allowed in the trimmed conversation context.

§Returns

A Result<(), TokenizerError> indicating success or failure.

Source

pub fn with_user_template( self, body: &str, parameters: &Parameters, ) -> Result<Self, StringTemplateError>

Adds a user message to the conversation by templating the specified template string and parameters.

§Arguments

body - A template string representing the message body.
parameters - Parameters used to template the message body

§Returns

Result<Self, StringTemplateError> If Ok() A Result containing a modified ChatMessageCollection with the new user message added on success, or an error if the body couldn’t be templated

Source

pub fn with_system_template( self, body: &str, parameters: &Parameters, ) -> Result<Self, StringTemplateError>

Adds a system message to the conversation by templating the specified template string and parameters.

§Arguments

body - A template string representing the message body.
parameters - Parameters used to template the message body

§Returns

Result<Self, StringTemplateError> If Ok() A Result containing a modified ChatMessageCollection with the new system message added on success, or an error if the body couldn’t be templated

Source

pub fn with_assistant_template( self, body: &str, parameters: &Parameters, ) -> Result<Self, StringTemplateError>

Adds a assistant message to the conversation by templating the specified template string and parameters.

§Arguments

body - A template string representing the message body.
parameters - Parameters used to template the message body

§Returns

Result<Self, StringTemplateError> If Ok() A Result containing a modified ChatMessageCollection with the new assistant message added on success, or an error if the body couldn’t be templated

Source §