feat: support deployment using FastAPI (#37)

Signed-off-by: Ruichen Bao <ruichen.bao@zju.edu.cn>

Author: brcarry

README.md

@@ -209,6 +209,25 @@ More help information
 ```shell
 deepsearcher --help
 ```
+### Deployment
+
+#### Configure modules
+
+You can configure all arguments by modifying [config.py](./config.py) to set up your system with default modules.
+For example, prepare your `OPENAI_API_KEY` in `llm_api_key`. 
+
+#### Start service
+The main script will run a FastAPI service with default address `localhost:8000`.
+
+```shell
+$ python main.py
+```
+
+#### Access via browser
+
+You can open url http://localhost:8000/docs in browser to access the web service.
+Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API
+
 
 ---
 

config.py

@@ -0,0 +1,6 @@
+from pydantic_settings import BaseSettings
+
+class Settings(BaseSettings):
+    llm_provider: str = "OpenAI"
+    llm_model: str = "gpt-4o-mini"
+    llm_api_key: str = "sk-xxxx"

main.py

@@ -0,0 +1,50 @@
+from fastapi import FastAPI, HTTPException
+from deepsearcher.configuration import Configuration, init_config
+from deepsearcher.offline_loading import load_from_local_files, load_from_website
+from deepsearcher.online_query import query
+import uvicorn
+from config import Settings
+
+app = FastAPI()
+
+settings = Settings()
+
+config = Configuration()
+
+config.set_provider_config(
+    "llm",
+    settings.llm_provider,
+    {
+        "model": settings.llm_model,
+        "api_key": settings.llm_api_key
+    }
+)
+
+init_config(config)
+
+@app.post("/load-files/")
+def load_files(paths: list[str], collection_name: str = None, collection_description: str = None):
+    try:
+        load_from_local_files(paths_or_directory=paths, collection_name=collection_name, collection_description=collection_description)
+        return {"message": "Files loaded successfully."}
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=str(e))
+
+@app.post("/load-website/")
+def load_website(urls: str, collection_name: str = None, collection_description: str = None):
+    try:
+        load_from_website(urls=urls, collection_name=collection_name, collection_description=collection_description)
+        return {"message": "Website loaded successfully."}
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=str(e))
+
+@app.get("/query/")
+def perform_query(original_query: str, max_iter: int = 3):
+    try:
+        result = query(original_query, max_iter)
+        return {"result": result}
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=str(e))
+
+if __name__ == "__main__":
+    uvicorn.run(app, host="0.0.0.0", port=8000)

requirements.txt

@@ -7,3 +7,6 @@ openai
 numpy
 tqdm
 termcolor
+fastapi
+uvicorn
+pydantic-settings

setup.py

@@ -15,6 +15,9 @@
         'numpy',
         'tqdm',
         'termcolor',
+        'fastapi',
+        'uvicorn',
+        'pydantic-settings'
     ],
     entry_points={
         'console_scripts': ['deepsearcher=deepsearcher.cli:main'],