From 0ed837329bea5f9859028b191287a8d15693cd1a Mon Sep 17 00:00:00 2001
From: Richard Anthony Hein <richard.hein@gmail.com>
Date: Tue, 13 Aug 2024 21:19:52 +0000
Subject: [PATCH] Added prompts for conversational RAG

---
 swarms/prompts/__init__.py           | 18 +++++++
 swarms/prompts/conversational_RAG.py | 78 ++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+)
 create mode 100644 swarms/prompts/conversational_RAG.py

diff --git a/swarms/prompts/__init__.py b/swarms/prompts/__init__.py
index d8a1dae9..74dc8405 100644
--- a/swarms/prompts/__init__.py
+++ b/swarms/prompts/__init__.py
@@ -1,4 +1,14 @@
 from swarms.prompts.code_interpreter import CODE_INTERPRETER
+from swarms.prompts.conversational_RAG import (
+    CONDENSE_PROMPT_TEMPLATE,
+    DOCUMENT_PROMPT_TEMPLATE,
+    QA_CONDENSE_TEMPLATE_STR,
+    QA_PROMPT_TEMPLATE,
+    QA_PROMPT_TEMPLATE_STR,
+    STUFF_PROMPT_TEMPLATE,
+    SUMMARY_PROMPT_TEMPLATE,
+    B_SYS, B_INST, E_SYS, E_INST,
+)
 from swarms.prompts.documentation import DOCUMENTATION_WRITER_SOP
 from swarms.prompts.finance_agent_prompt import FINANCE_AGENT_PROMPT
 from swarms.prompts.growth_agent_prompt import GROWTH_AGENT_PROMPT
@@ -16,4 +26,12 @@ __all__ = [
     "OPERATIONS_AGENT_PROMPT",
     "PRODUCT_AGENT_PROMPT",
     "DOCUMENTATION_WRITER_SOP",
+    "CONDENSE_PROMPT_TEMPLATE",
+    "DOCUMENT_PROMPT_TEMPLATE",
+    "QA_CONDENSE_TEMPLATE_STR",
+    "QA_PROMPT_TEMPLATE",
+    "QA_PROMPT_TEMPLATE_STR",
+    "STUFF_PROMPT_TEMPLATE",
+    "SUMMARY_PROMPT_TEMPLATE",
+    "B_SYS", "B_INST", "E_SYS", "E_INST",
 ]
diff --git a/swarms/prompts/conversational_RAG.py b/swarms/prompts/conversational_RAG.py
new file mode 100644
index 00000000..ed4708af
--- /dev/null
+++ b/swarms/prompts/conversational_RAG.py
@@ -0,0 +1,78 @@
+from langchain.prompts.prompt import PromptTemplate
+
+B_INST, E_INST = "[INST]", "[/INST]"
+B_SYS, E_SYS = "<<SYS>>\n", "\n<</SYS>>\n\n"
+
+QA_CONDENSE_TEMPLATE_STR = (
+    "Given the following Chat History and a Follow Up Question, "
+    "rephrase the follow up question to be a new Standalone Question, "
+    "but make sure the new question is still asking for the same "
+    "information as the original follow up question. Respond only "
+    " with the new Standalone Question. \n"
+    "Chat History: \n"
+    "{chat_history} \n"
+    "Follow Up Question: {question} \n"
+    "Standalone Question:"
+)
+
+CONDENSE_PROMPT_TEMPLATE = PromptTemplate.from_template(
+    f"{B_INST}{B_SYS}{QA_CONDENSE_TEMPLATE_STR.strip()}{E_SYS}{E_INST}"
+)
+
+QA_PROMPT_TEMPLATE_STR = (
+    "HUMAN: \n You are a helpful AI assistant.  "
+    "Use the following context and chat history to answer the "
+    "question at the end with a helpful answer.  "
+    "Get straight to the point and always think things through step-by-step before answering.  "
+    "If you don't know the answer, just say 'I don't know'; "
+    "don't try to make up an answer. \n\n"
+    "<context>{context}</context>\n"
+    "<chat_history>{chat_history}</chat_history>\n"
+    "<question>{question}</question>\n\n"
+    "AI:  Here is the most relevant sentence in the context:  \n"
+)
+
+QA_PROMPT_TEMPLATE = PromptTemplate.from_template(
+    f"{B_INST}{B_SYS}{QA_PROMPT_TEMPLATE_STR.strip()}{E_SYS}{E_INST}"
+)
+
+DOCUMENT_PROMPT_TEMPLATE = PromptTemplate(
+    input_variables=["page_content"], template="{page_content}"
+)
+
+_STUFF_PROMPT_TEMPLATE_STR = "Summarize the following context: {context}"
+
+STUFF_PROMPT_TEMPLATE = PromptTemplate.from_template(
+    f"{B_INST}{B_SYS}{_STUFF_PROMPT_TEMPLATE_STR.strip()}{E_SYS}{E_INST}"
+)
+
+_SUMMARIZER_SYS_TEMPLATE = (
+    B_INST
+    + B_SYS
+    + """Progressively summarize the lines of conversation provided, adding onto the previous summary returning a new summary.
+    EXAMPLE
+    Current summary:
+    The human asks what the AI thinks of artificial intelligence. The AI thinks artificial intelligence is a force for good.
+    New lines of conversation:
+    Human: Why do you think artificial intelligence is a force for good?
+    AI: Because artificial intelligence will help humans reach their full potential.
+    New summary:
+    The human asks what the AI thinks of artificial intelligence. The AI thinks artificial intelligence is a force for good because it will help humans reach their full potential.
+    END OF EXAMPLE"""
+    + E_SYS
+    + E_INST
+)
+
+_SUMMARIZER_INST_TEMPLATE = (
+    B_INST
+    + """Current summary:
+    {summary}
+    New lines of conversation:
+    {new_lines}
+    New summary:"""
+    + E_INST
+)
+
+SUMMARY_PROMPT_TEMPLATE = PromptTemplate.from_template(
+    template=(_SUMMARIZER_SYS_TEMPLATE + "\n" + _SUMMARIZER_INST_TEMPLATE).strip()
+)
\ No newline at end of file