Struct ChatHistoryChain

pub struct ChatHistoryChain<T>
where
    T: AsyncChatClient,
{ /* private fields */ }

ChatHistoryChain

The chat history chain executes the workflow of saving each message in the conversation history. that is then resent with each subsequent request to the chat client. So previous messages can be

• T - The type of the chat client to be used

Examples

use rag_toolchain::clients::*;
use rag_toolchain::chains::*;

async fn run_chain() {
    const SYSTEM_MESSAGE: &'static str = "You are a chat bot that must answer questions accurately";
    let system_prompt = PromptMessage::SystemMessage(SYSTEM_MESSAGE.into());
    let client = OpenAIChatCompletionClient::try_new(OpenAIModel::Gpt3Point5Turbo).unwrap();
    let chain = ChatHistoryChain::new(client, system_prompt);
    let user_prompt1 = PromptMessage::HumanMessage("Please tell me about the weather".into());
    let response1 = chain.invoke_chain(user_prompt1).await.unwrap();
    let user_prompt2 =
    PromptMessage::HumanMessage("What was the last question I just asked ?".into());
    let response2 = chain.invoke_chain(user_prompt2).await.unwrap();
    println!("Response 1: {}", response1.content());
    println!("Response 2: {}", response2.content());
}

Implementations

impl<T> ChatHistoryChain<T>

where T: AsyncChatClient,

pub fn new(chat_client: T, system_prompt: PromptMessage) -> Self

ChatHistoryChain::new

This constructor to create a new ChatHistoryChain.

Arguments

• chat_client: T - The chat client to be used
• system_prompt: PromptMessage - The system prompt, please use PromptMessage::SystemMessage

pub async fn invoke_chain( &self, user_message: PromptMessage, ) -> Result<PromptMessage, ChainError<T::ErrorType>>

ChatHistoryChain::invoke_chain

function to execute the ChatHistoryChain given a new user prompt. Each time this method is invoked, the user message is added to the chat history.

Arguments

• user_message: PromptMessage - the user prompt that will be sent to the LLM along with the chat history.

Errors

• ChainError::ChatClientError if the chat client invocation fails.

Returns

• PromptMessage::AIMessage - the response from the chat client.

Trait Implementations

impl<T> Clone for ChatHistoryChain<T>

where T: AsyncChatClient + Clone,

fn clone(&self) -> ChatHistoryChain<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ChatHistoryChain<T>

where T: AsyncChatClient + Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for ChatHistoryChain<T>

where T: AsyncChatClient + PartialEq,

fn eq(&self, other: &ChatHistoryChain<T>) -> 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<T> Eq for ChatHistoryChain<T>

where T: AsyncChatClient + Eq,

impl<T> StructuralPartialEq for ChatHistoryChain<T>

where T: AsyncChatClient,