RAG Chatbot with Confluence

法学硕士

帮助台允许您使用公司 Confluence 数据创建具有精简 UI 的问答机器人。

如何使用

• 创建虚拟环境：

  • python3.10 -m venv .venv
  • source .venv/bin/activate
  • pip install -r requirements.txt

• 复制 env.template 并填充您的环境变量

  • cp .env.template .env

• 检查config.py和env.template文件。

• 要从 Confluence 收集数据，您必须：

  • 使用页面信息创建您自己的 Conluence 空间
  • 在此处创建并提供您的 API 密钥
  • 在env文件中插入：
    • space_key： https://yoursite.atlassian.com/wiki/spaces/<space_key>/pages/ /
    • 空间名称： <space_name>/spaces/<space_key>/pages/
    • 您用于 Confluence 空间的电子邮件地址
    • OpenAI API 密钥

• 要运行 Streamlit 应用程序，请运行：

 cd src
streamlit run streamlit.py

• 评估 RAG 模型的质量：

 # First replace the evaluation dataset file in the data folder with your topic questions
cd src
python evaluate.py

• 使用并深入了解笔记本电脑

 ipython kernel install --name RAG --user  # Add the notebook kernel
jupyter lab

它是如何运作的？

 .
├── data/
    ├── evaluation_dataset.tsv  # Questions and answers useful for evaluation

├── docs/                       # Documentation files
├── src/                        # The main directory for computer demo
    ├── __init__.py
    ├── load_db.py              # Load data from confluence and creates smart chunks
    ├── help_desk.py            # Instantiates the LLMs, retriever and chain
    ├── main.py                 # Run the Chatbot for a simple question
    ├── streamlit.py            # Run the Chatbot in streamlit where you can ask your own questions
    ├── evaluate.py             # Evaluate the RAG model based on questions-answers samples

├── notebooks/                  # Interactive code, useful for try and learn
├── config.py
├── .env.template               # Environment variables to feed
├── .gitignore
├── LICENSE                     # MIT License
├── README.md                   # Where to start
└── requirements.txt            # The dependencies

流程如下：

• 从 Confluence 加载数据
  • 您可以使用我们的 MR 中添加的keep_markdown_format选项来保留 Markdown 样式
  • 请参阅help_desk.ipynb进行更深入的分析
  • 否则，您无法使用 MarkdownHeaderTextSplitter 以智能方式分割文本
• 加载数据
• Markdown 和 RecursiveCharacterTextSplitter
• 使用的 LLM：开放 AI LLM 和嵌入
• QA检索链
• Streamlit 作为数据接口