😎 Add a gradio UI

Makefile

@@ -20,6 +20,9 @@ build:
 publish: clean build
 	$(PYTHON) -m twine upload dist/*
 
+trace:
+	langchain-server	
+
 help:
 	@echo "install - install dependencies"
 	@echo "test - run tests"

qnabot/QnABot.py

@@ -11,7 +11,7 @@ import os
 class QnABot:
     def __init__(
         self,
-        directory: str,
+        directory: str | None = None,
         index: str | None = None,
         model: str | None = None,
         verbose: bool = False,
@@ -36,7 +36,9 @@ class QnABot:
             print("Using model: text-davinci-003")
             self.llm = OpenAI(temperature=temperature)
 
-    def create_loader(self, directory: str):
+    def create_loader(self, directory: str | None):
+        if directory is None:
+            return
         # Create a loader based on the provided directory (either local or S3)
         if directory.startswith("s3://"):
             self.loader = S3DirectoryLoader(directory)
@@ -66,7 +68,7 @@ class QnABot:
         a = self.chain.run(input_documents=input_documents, question=question)
         print(a)
 
-    def get_answer(self, question: str, k=1) -> str:
+    def ask(self, question: str, k=1) -> str:
         # Retrieve the answer to the given question and return it
         input_documents = self.search_index.similarity_search(question, k=k)
         answer = self.chain.run(input_documents=input_documents, question=question)

qnabot/__init__.py

@@ -1,2 +1,3 @@
 from .QnABot import QnABot
 from .api import create_app
+from .ui import create_interface

qnabot/api.py

@@ -7,7 +7,7 @@ def create_app(bot: QnABot):
 
     @app.get("/v1/ask/{question}")
     async def ask(question: str):
-        answer = bot.get_answer(question)
+        answer = bot.ask(question)
         return {"answer": answer}
 
     return app

qnabot/tests/test_QnABot.py

@@ -14,9 +14,9 @@ correct_answer = "Iron Man, Thor, Hulk, Ant-Man"
 sources = "SOURCES:"
 
 
-def test_get_answer():
+def test_ask():
     bot = QnABot(directory=test_directory)
-    answer = bot.get_answer(test_question)
+    answer = bot.ask(test_question)
 
     # Assert that the answer contains the correct answer
     assert correct_answer in answer
@@ -41,4 +41,4 @@ def test_save_load_index():
         bot_with_predefined_index = QnABot(directory=test_directory, index=index_path)
 
         # Assert that the bot returns the correct answer to the test question
-        assert correct_answer in bot_with_predefined_index.get_answer(test_question)
+        assert correct_answer in bot_with_predefined_index.ask(test_question)

qnabot/tests/test_ui.py

@@ -0,0 +1,20 @@
+import gradio as gr
+from qnabot import create_interface
+
+
+def test_create_interface():
+    # create a mock QnABot object
+    class MockBot:
+        def ask(self, question: str):
+            return "Answer"
+
+    # create a mock example
+    example = [["What is your name?"], ["My name is Bot."]]
+
+    # call the function with the mock bot and example
+    interface = create_interface(MockBot(), examples=example)
+
+    # check if the interface has the correct properties
+    assert isinstance(interface, gr.Interface)
+    assert len(interface.examples) == 2
+    assert interface.examples == example

qnabot/ui.py

@@ -0,0 +1,16 @@
+import gradio as gr
+from qnabot import QnABot
+
+
+def create_interface(bot: QnABot, examples: list[list[str]] = []):
+    def ask(question: str):
+        return bot.ask(question)
+
+    interface = gr.Interface(
+        fn=ask,
+        inputs=gr.components.Textbox(lines=5, label="Question"),
+        outputs=gr.components.Textbox(lines=5, label="Answer"),
+        examples=examples,
+    )
+
+    return interface

setup.py

@@ -12,7 +12,7 @@ setup(
         "unstructured",
         "fastapi",
         "faiss-cpu",
-        "fastapi",
+        "pdfminer.six",
     ],
     author="Megaklis Vasilakis",
     author_email="megaklis.vasilakis@gmail.com",