hugging face qa bot
v0.3
一個多界面的問答系統，使用擁抱面部的LLM和檢索增強發電（RAG）根據擁抱的面部文檔提供答案。它可以作為API，Discord Bot或Gradio應用程序操作，還提供了用於製定每個答案的文檔的鏈接。
要執行任何可用接口，請根據位於config/ Directory中的.env.example指定.env文件中所需的參數。另外，您可以將這些設置為環境變量：
QUESTION_ANSWERING_MODEL_ID （str）一個字符串，該字符串指定了來自擁抱臉部集線器的模型ID或包含模型權重的目錄EMBEDDING_MODEL_ID （str）從擁抱臉部集線器中嵌入模型ID。我們建議使用hkunlp/instructor-largeINDEX_REPO_ID （str）存儲索引存儲的索引中心的存儲庫ID。在本節中可以找到最實際索引的列表：索引PROMPT_TEMPLATE_NAME （str）用於問答的模型提示模板的名稱，模板存儲在config/api/prompt_templates目錄中USE_DOCS_FOR_CONTEXT （bool）使用檢索到的文檔作為給定查詢的上下文NUM_RELEVANT_DOCS （int）上一個功能的文檔數量ADD_SOURCES_TO_RESPONSE （bool）包括用作給定查詢上下文的檢索文檔的來源USE_MESSAGES_IN_CONTEXT （BOOL）使用聊天歷史記錄進行對話體驗DEBUG - （布爾）提供額外的記錄從需求文件中安裝必要的依賴項：
pip install -r requirements.txt完成設置部分中所述的所有步驟後，將APP_MODE環境變量指定為gradio並運行以下命令：
python3 app.py默認情況下，API是在http://0.0.0.0:8000上提供的。要啟動它，請完成設置部分中概述的所有步驟，然後執行以下命令：
python3 -m api要作為Discord Bot與系統交互，請在config/目錄中的.env.example文件的Discord bot部分中添加其他必需的環境變量。
DISCORD_TOKEN （str）機器人應用程序的API密鑰QA_SERVICE_URL API服務的URL。我們建議使用： http://0.0.0.0:8000NUM_LAST_MESSAGES （int）在對話中用於上下文的消息數USE_NAMES_IN_CONTEXT （bool）在對話上下文中包含用戶名ENABLE_COMMANDS （bool）允許命令，例如，通道清理DEBUG - （布爾）提供額外的記錄完成所有步驟後，運行：
python3 -m bot要在擁抱面積的空間上託管機器人，請指定APP_MODE環境變量為discord ，並且該機器人將從app.py文件自動運行。
以下列表包含可用於系統的最新索引：
我們使用Python 3.10
要安裝所有必要的Python軟件包，請運行以下命令：
pip install -r requirements.txt我們使用PIPREQSNB生成unignts.txt文件。要安裝PIPREQSNB，請運行以下命令：
pip install pipreqsnb要生成需求.txt文件，請運行以下命令：
pipreqsnb --force .要運行單元測試，您可以使用以下命令：
pytest -o " testpaths=tests " --noconftest
