Update (see details)

app.py, README.md, README.zh-TW.md, img
1. add logo

docGPT.py
1. Add refine prompt
2. Redesign the prompt to enhance the readability of the response.

Author: Lin-jun-xiang

README.md

@@ -1,4 +1,7 @@
-# docGPT
+<p align="center">
+    <img style="width: 50%; height: auto;" src="./img/repos_logo.png" alt="Chatbot Image">
+</p>
+
 
 [English](./README.md) | [中文版](./README.zh-TW.md)
 

README.zh-TW.md

@@ -1,4 +1,6 @@
-# docGPT
+<p align="center">
+    <img style="width: 50%; height: auto;" src="./img/repos_logo.png" alt="Chatbot Image">
+</p>
 
 [English](./README.md) | [中文版](./README.zh-TW.md)
 

app.py

@@ -27,13 +27,9 @@
 
 
 def theme() -> None:
-    st.set_page_config(page_title="DocGPT")
-    icon, title = st.columns([3, 20])
-    with icon:
-        st.image('./img/chatbot.png')
-    with title:
-        st.title('PDF Chatbot')
-    
+    st.set_page_config(page_title="Document GPT")
+    st.image('./img/repos_logo.png', width=250)
+
     with st.sidebar:
 
         with st.expander(':orange[How to use?]'):

docGPT/docGPT.py

@@ -13,7 +13,6 @@
 from langchain.memory import ConversationBufferMemory
 from langchain.prompts import PromptTemplate
 from langchain.vectorstores import FAISS
-from tenacity import retry, stop_after_attempt
 
 openai.api_key = os.getenv('OPENAI_API_KEY')
 
@@ -87,22 +86,44 @@ def __init__(self, docs):
         self.qa_chain = None
         self._llm = None
 
-        self.prompt_template = """
-        Only answer what is asked. Answer step-by-step.
-        If the content has sections, please summarize them in order and present them in a bulleted format.
-        Utilize line breaks for better readability.
-        For example, sequentially summarize the introduction, methods, results, and so on.
-
-        {context}
-
-        Question: {question}
-        """
-
+        self.prompt_template = (
+            "Only answer what is asked. Answer step-by-step.\n"
+            "If the content has sections, please summarize them "
+            "in order and present them in a bulleted format.\n"
+            "Utilize line breaks for better readability.\n"
+            "For example, sequentially summarize the "
+            "introduction, methods, results, and so on.\n"
+            "Please use Python's newline symbols appropriately to "
+            "enhance the readability of the response, "
+            "but don't use two newline symbols consecutive.\n\n"
+            "{context}\n\n"
+            "Question: {question}\n"
+        )
         self.prompt = PromptTemplate(
             template=self.prompt_template,
             input_variables=['context', 'question']
         )
 
+        self.refine_prompt_template = (
+            "The original question is as follows: {question}\n"
+            "We have provided an existing answer: {existing_answer}\n"
+            "We have the opportunity to refine the existing answer"
+            "(only if needed) with some more context below.\n"
+            "------------\n"
+            "{context_str}\n"
+            "------------\n"
+            "Given the new context, refine the original answer to better "
+            "answer the question. "
+            "If the context isn't useful, return the original answer.\n"
+            "Please use Python's newline symbols "
+            "appropriately to enhance the readability of the response, "
+            "but don't use two newline symbols consecutive.\n"
+        )
+        self.refine_prompt = PromptTemplate(
+            template=self.refine_prompt_template,
+            input_variables=['question', 'existing_answer', 'context_str']
+        )
+
     @property
     def llm(self):
         return self._llm
@@ -143,7 +164,8 @@ def create_qa_chain(
         self._helper_prompt(chain_type)
         chain_type_kwargs = {
             'question_prompt': self.prompt,
-            'verbose': True
+            'verbose': True,
+            'refine_prompt': self.refine_prompt
         }
 
         db = self._embeddings()