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