Update prompt and add link to github project

app.py

@@ -5,40 +5,74 @@ import gradio as gr
 
 from src.rag_pipeline.rag_system import RAGSystem
 
+# Set environment variable to optimize tokenization performance
 os.environ["TOKENIZERS_PARALLELISM"] = "true"
 
 
 class ChatInterface:
+    """Interface for interacting with the RAG system via Gradio's chat component."""
+
     def __init__(self, rag_system: RAGSystem):
         self.rag_system = rag_system
 
-    def respond(self, message: str, history: List[List[str]]):
+    def respond(self, message: str, history: List[dict]):
+        """
+        Processes a user message and returns responses incrementally using the RAG system.
+
+        Args:
+            message (str): User's input message.
+            history (List[dict]): Chat history as a list of role-content dictionaries.
+
+        Yields:
+            str: Incremental response generated by the RAG system.
+        """
+        # Convert history to (role, content) tuples and limit to the last 10 turns
+        processed_history = [(turn["role"], turn["content"]) for turn in history][-10:]
         result = ""
-        history = [(turn["role"], turn["content"]) for turn in history]
-        # limit history to 10 to avoid message length limit
-        for text in self.rag_system.query(message, history[-10:]):
+
+        # Generate response incrementally
+        for text in self.rag_system.query(message, processed_history):
             result += text
             yield result
-        return result
 
-    def create_interface(self):
-        chat_interface = gr.ChatInterface(
+    def create_interface(self) -> gr.ChatInterface:
+        """
+        Creates the Gradio chat interface for Medivocate.
+
+        Returns:
+            gr.ChatInterface: Configured Gradio chat interface.
+        """
+        description = (
+            "Medivocate is an application that offers clear and structured information "
+            "about African history and traditional medicine. The knowledge is exclusively "
+            "based on historical documentaries about the African continent.\n\n"
+            "🌟 **Code Repository**: [Medivocate GitHub](https://github.com/KameniAlexNea/medivocate)"
+        )
+        return gr.ChatInterface(
             fn=self.respond,
             type="messages",
             title="Medivocate",
-            description="Medivocate est une application qui offre des informations claires et structurées sur l'histoire de l'Afrique et sa médecine traditionnelle, en s'appuyant exclusivement sur un contexte issu de documentaires sur l'histoire du continent africain.",
+            description=description,
         )
-        return chat_interface
 
-    def launch(self, share=False):
+    def launch(self, share: bool = False):
+        """
+        Launches the Gradio interface.
+
+        Args:
+            share (bool): Whether to generate a public sharing link. Defaults to False.
+        """
         interface = self.create_interface()
         interface.launch(share=share)
 
 
-# Usage example:
+# Entry point
 if __name__ == "__main__":
-    rag_system = RAGSystem(top_k_documents=12)
+    # Initialize the RAG system with specified parameters
+    top_k_documents = 12
+    rag_system = RAGSystem(top_k_documents=top_k_documents)
     rag_system.initialize_vector_store()
 
+    # Create and launch the chat interface
     chat_interface = ChatInterface(rag_system)
     chat_interface.launch(share=False)

src/rag_pipeline/prompts.py

@@ -6,16 +6,20 @@ from langchain.prompts.chat import (
 )
 
 system_template = """
-Vous êtes un assistant IA qui fournit des informations sur l'histoire de l'Afrique et la médecine traditionnelle africaine. Vous recevez une question et fournissez une réponse claire et structurée. Lorsque cela est pertinent, utilisez des points et des listes pour structurer vos réponses.
-
-Utilisez uniquement les éléments de contexte suivants pour répondre à la question de l'utilisateur. Si vous ne connaissez pas la réponse, dites simplement que vous ne savez pas, n'essayez pas d'inventer une réponse.
-
-Si la question posée est dans une langue parlée en Afrique ou demande une traduction dans une de ces langues, répondez que vous ne savez pas et demandez à l'utilisateur de reformuler sa question.
-
-Si vous connaissez la réponse à la question mais que cette réponse ne provient pas du contexte ou n'est pas relative à l'histoire africaine ou à la médecine traditionnelle, répondez que vous ne savez pas et demandez à l'utilisateur de reformuler sa question.
-
------------------
-{context}
+**Vous êtes un assistant IA spécialisé dans l'histoire de l'Afrique et la médecine traditionnelle africaine. Votre rôle est de fournir des réponses claires, structurées et précises en utilisant exclusivement les éléments de contexte suivants :**  
+-----------------  
+{context}  
+-----------------  
+
+**Règles à suivre :**  
+1. **Utilisez uniquement le contexte fourni pour répondre. **Si une information n'est pas présente dans le contexte, répondez : *"Je ne sais pas. Je ne dispose pas d'informations à ce sujet."*  
+2. **Répondez uniquement aux questions en lien avec l'histoire de l'Afrique ou la médecine traditionnelle africaine.** Si une question n'est pas pertinente, indiquez :  
+   *"Je ne peux répondre qu'à des questions relatives à l'histoire africaine ou à la médecine traditionnelle. Pouvez-vous reformuler votre question en lien avec ces sujets ?"*  
+3. **Structurez vos réponses** : Lorsque pertinent, utilisez des points ou des listes pour rendre l'information plus claire et accessible.  
+4. **Ne devinez pas.** Si le contexte est insuffisant pour répondre précisément, dites :  
+   *"Je ne sais pas. Les informations dont je dispose ne couvrent pas ce sujet."*  
+
+**Votre priorité est de fournir des informations exactes et de ne jamais sortir du cadre défini.**
 """
 
 messages = [