Struct Conversation

pub struct Conversation {
    pub history: Vec<ChatMessage>,
    pub always_send_functions: bool,
    /* private fields */
}

Stores a single conversation session, and automatically saves message history

Fields

history: Vec<ChatMessage>

All the messages sent and received, starting with the beginning system message

always_send_functions: bool

Set to true if you want to automatically send all functions to API with each message.

Functions are counted as tokens internally, so it is set to false by default.

Implementations

impl Conversation

pub fn new(client: ChatGPT, first_message: String) -> Self

Constructs a new conversation from an API client and the introductory message

pub fn new_with_history(client: ChatGPT, history: Vec<ChatMessage>) -> Self

Constructs a new conversation from a pre-initialized chat history

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

Rollbacks the history by 1 message, removing the last sent and received message.

pub fn add_function<A: FunctionArgument + Send + Sync + 'static, C: CallableAsyncFunction<A> + Send + Sync + 'static>( &mut self, prebuilt: GptFunction<A, C>, ) -> Result<()>

Adds a function that can later be called by ChatGPT

pub fn send_role_message<'life_self, 'async_recursion, S>( &'life_self mut self, role: Role, message: S, ) -> Pin<Box<dyn Future<Output = Result<CompletionResponse>> + Send + 'async_recursion>>

where S: 'async_recursion + Into<String> + Send + Sync, 'life_self: 'async_recursion,

Sends a message from a specified role to the ChatGPT API and returns the completion response.

pub async fn send_message<S: Into<String> + Send + Sync>( &mut self, message: S, ) -> Result<CompletionResponse>

Sends the message to the ChatGPT API and returns the completion response.

Execution speed depends on API response times.

pub async fn send_message_functions<S: Into<String>>( &mut self, message: S, ) -> Result<CompletionResponse>

Sends a message with all functions to the ChatGPT API and returns the completion response.

NOTE: Functions are counted as tokens internally.

pub async fn send_role_message_streaming<S: Into<String>>( &mut self, role: Role, message: S, ) -> Result<impl Stream<Item = Result<ResponseChunk>>>

Sends a message with specified role to the ChatGPT API and returns the completion response as stream.

Note, that this method will not automatically save the received message to history, as it is returned in streamed chunks. You will have to collect them into chat message yourself.

You can use ChatMessage::from_response_chunks for this

Requires the streams crate feature.

pub async fn send_message_streaming<S: Into<String>>( &mut self, message: S, ) -> Result<impl Stream<Item = Result<ResponseChunk>>>

Sends the message to the ChatGPT API and returns the completion response as stream.

Note, that this method will not automatically save the received message to history, as it is returned in streamed chunks. You will have to collect them into chat message yourself.

You can use ChatMessage::from_response_chunks for this

Requires the streams crate feature.

pub async fn save_history_json<P: AsRef<Path>>(&self, to: P) -> Result<()>

Saves the history to a local JSON file, that can be restored to a conversation at runtime later.

pub async fn save_history_postcard<P: AsRef<Path>>(&self, to: P) -> Result<()>

Saves the history to a local postcard file, that can be restored to a conversation at runtime later.