Update README [skip ci]

Mgrsc · Jan 2, 2025 · 659400c · 659400c
1 parent 5d87b5a
commit 659400c
Show file tree

Hide file tree

Showing 3 changed files with 200 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -1,131 +1,225 @@
-# 🤖 LLMQ-Horizon QQ_Chatbot
+<div align="center">
 
-一个基于 NoneBot2 和 LangGraph 的QQ_Chatbot。
+<img src="static/LLMQ.webp" width="400" style="margin-bottom: 10px;">
 
-## ✨ 特性
+# 🤖 LLMQ-Horizon QQ 聊天机器人
 
-- 🔌 支持多种工具扩展
-- 💬 支持群聊和私聊
-- 🎯 多种触发方式:
-  - @机器人
-  - 关键词触发
-  - 命令前缀触发
-- 🧠 基于 LangGraph 的对话管理
-- 📦 自动会话管理和清理
+**基于 NoneBot2 和 LangGraph 的智能 QQ 机器人，支持多模型对话、工具调用和会话管理**
 
-# 快速开始
+<br>
 
-## 部署
-```
+**工具均采用 Function-calling 编写, 不使用插件，参考 [OpenAI Function Calling](https://platform.openai.com/docs/guides/function-calling) , [LangChain Tools](https://python.langchain.com/docs/how_to/#tools)**
+
+<br>
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FMgrsc%2FLLMQ-Horizon.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2FMgrsc%2FLLMQ-Horizon?ref=badge_small)
+[![Docker Release](https://img.shields.io/docker/pulls/bitfennec/llmq-horizon?color=%230077c8&label=Docker%20Pulls&logo=docker&logoColor=white&style=flat)](https://hub.docker.com/r/bitfennec/llmq-horizon)
+[![License](https://img.shields.io/github/license/Mgrsc/LLMQ-Horizon?color=%2300c853&label=MIT%20License&style=flat)](https://github.com/Mgrsc/LLMQ-Horizon/blob/main/LICENSE)
+
+</div>
+
+---
+
+## ✨ 主要特性
+
+-   **🔌 丰富的工具集成：** 代码运行、天气查询、占卜、绘画等
+-   **🤖 支持多种大模型：** OpenAI、Google Gemini、Groq 等
+-   **💬 完善的对话管理：** 群聊/私聊、多轮对话、会话隔离
+-   **🎯 灵活的触发方式：** @、关键词、命令前缀
+-   **🎨 多媒体能力：** 图片分析、音视频处理
+-   **⚡ 自动的会话管理：** 超时清理、并发控制
+-   **🦖 强大的扩展能力：** 可自行编写 tools，可使用 tools 控制 nonebot
+
+---
+
+## 🚀 快速开始
+
+### 1. 部署环境准备
+
+-   Docker 和 Docker Compose
+-   稳定的网络环境
+-   建议系统：Ubuntu 22.04 及以上, Debian 11 以上
+
+### 2. 安装步骤
+
+```bash
+# 1. 克隆项目
 git clone https://github.com/Mgrsc/LLMQ-Horizon.git
+cd LLMQ-Horizon
 
-# 把示例文件改名
-mv config-tools.toml.example config-tools.toml
-mv config.toml.example config.toml
+# 2. 准备配置文件
+cp config-tools.toml.example config-tools.toml
+cp config.toml.example config.toml
+cd napcat/config/
+mv onebot11_qq.json onebot11_<你的QQ>.json  # 替换为实际 QQ 号
 
-# 参考下面编辑配置文件
+# 3. 修改配置(参考配置文件中的注释进行修改)
+vim config.toml
+vim config-tools.toml
 
-# 启动
+# 4. 启动服务
 docker compose up -d
-# 修改配置仅需重启llmq
-docker compose down llmq
-# 关闭
+
+# 5. 扫码登录
+docker compose logs -f
+
+# 重启 LLMQ 服务
+docker compose restart llmq
+
+# 停止所有服务
 docker compose down
 ```
 
-### 编辑napcat
-```
-cd napcat/config/
-mv onebot11_qq.json onebot11_<你的QQ>.json #改为你的qq号
-```
+## 🛠️ 工具配置
 
-### 编辑compose
+<details>
+<summary>💻 代码运行 (Code Runner - Judge0)</summary>
 
-```
-#填入超级用户QQ，用于命令执行
+[Judge0 官方部署教程](https://github.com/judge0/judge0/blob/master/CHANGELOG.md)
+
+1. **准备 Ubuntu 22.04 以上环境及 Docker，配置 cgroup v1：**
+
+    ```bash
+    sudo sed -i 's/GRUB_CMDLINE_LINUX=""/GRUB_CMDLINE_LINUX="systemd.unified_cgroup_hierarchy=0"/' /etc/default/grub
+    sudo update-grub
+    sudo reboot
+    ```
+
+2. **部署 Judge0：**
+
+    ```bash
+    wget https://github.com/judge0/judge0/releases/download/v1.13.1/judge0-v1.13.1.zip
+    unzip judge0-v1.13.1.zip
+    cd judge0-v1.13.1
+
+    # 生成两个密码并设置密码
+    openssl rand -hex 32
+
+    # 使用生成的密码更新 judge0.conf 文件中的 REDIS_PASSWORD 和 POSTGRES_PASSWORD 变量。
+
+    # 启动服务
+    docker-compose up -d db redis
+    sleep 10s
+    docker-compose up -d
+    sleep 5s
+    ```
+
+    您的 Judge0 CE v1.13.1 实例现已启动并运行；访问 http://<您的服务器 IP 地址>:2358/docs 获取文档。
+
+3. **配置 config-tools.toml：**
+
+    ```toml
+    [code_runner]
+    judge0_url = "http://your-server:2358"
+    judge0_api_key = "your-api-key"
+    ```
+
+</details>
+
+<details>
+<summary>😎 备忘录 (memos_manage - Memos)</summary>
+
+[Memos 官方部署教程](https://www.usememos.com/docs/install/container-install)
+
+1. **准备 Ubuntu 22.04 以上环境及 Docker：**
+
+2. **编写 docker-compose.yaml 文件**
+
+    ```yaml
+    services:
+      memos:
+        image: neosmemo/memos:stable
+        container_name: memos
+        ports:
+          - 5230:5230
+        volumes:
+          - ./memos:/var/opt/memos
+        restart: always
+    ```
+
+3. **启动 memos**
+
+    ```shell
+    docker compose up -d
+    ```
+
+    此时就可以在 http://<您的服务器 IP 地址>:5230 访问到 memos，在 memos 中的 Settings 中获取 Tokens
+
+4. **填写配置文件**
+
+    ```toml
+    [memos]
+    url = "http://your-server:xxx"
+    memos_token = "<填入获取的tokens>"
+    default_visibility = "PRIVATE"
+    page_size = 10
+    user_id = 6
+    ```
+
+</details>
+
+## 📝 命令说明
+
+| 命令                      | 说明                             |
+| :------------------------ | :------------------------------- |
+| `/chat model <模型名>`   | 切换对话模型                     |
+| `/chat clear`             | 清理所有会话                     |
+| `/chat group <true/false>` | 开关群聊隔离                     |
+| `/chat down`              | 关闭对话功能                     |
+| `/chat up`                | 开启对话功能                     |
+| `/chat chunk <true/false>` | 开关分段发送                     |
+
+## ❗ 常见问题
+
+<details>
+<summary>1. 登录失败</summary>
+
+-   检查 QQ 号配置是否正确
+-   确认 napcat 配置文件格式
+-   查看 napcat 容器日志排查问题
+
+</details>
+
+<details>
+<summary>2. 工具调用失败</summary>
+
+-   确认模型支持函数调用能力
+-   检查相关 API 密钥配置
+-   查看 LLMQ 容器日志定位错误
+-   在 docker 容器中加入 [LangSmith](https://smith.langchain.com/) 进行 debug
+
+    ```yaml
     environment:
-      - ACCOUNT=<qq>
-```
+      - LANGCHAIN_TRACING_V2=true
+      - LANGCHAIN_ENDPOINT="https://api.smith.langchain.com"
+      - LANGCHAIN_API_KEY="<your_api_key>"
+      - LANGCHAIN_PROJECT="<your_project_name>"
+    ```
 
-### 编辑config.toml
+</details>
 
-```
-[llm]
-model = "gpt-4o" # 模型必须支持fc否则无法使用tools
-superusers = "1221212" # 超级用户QQ
-groq_api_key = "xxxxxxxxxx"
-google_api_key = "xxxxxxxxxxx"
-api_key = "xxxxxxxx"
-base_url = "https://xxx.xxx.com/v1"
-temperature = 0.4 # 注意范围是0-1不要调太大
-command_start = "?" # 触发命令前缀
-system_prompt= """ """ #编写提示词，工具调用有问题请调节
-
-[plugin.llm_chat]
-# 触发命令
-Trigger_words = ["小宝","qw",]
-# 触发方式"prefix", "keyword", "at"
-Trigger_mode = ["prefix","at",]
-# 是否开启群对话隔离，群里每个人对话都是隔离开的
-group_chat_isolation = false
-# 是否传递用户名给LLM格式为 "用户名：消息"
-enable_username = true
-# 是否允许私聊
-enable_private = true
-# 是否允许群聊
-enable_group = true
-max_sessions = 1000
-# 默认回复列表，空艾特，空触发回复
-empty_message_replies = [
-    "说",
-    "？",
-    "内容？",
-    "问题？"
-    ]
-```
+<details>
+<summary>3. 其他问题</summary>
 
+-   其他问题请加 QQ 群讨论
+    ![qrcode](static/qrcode.jpg)
 
+</details>
 
-## 编辑config-tools.toml
-```
-- img_analysis：视觉能力，填写视觉模型，仅支持openai请求，可以使用new-api等项目转换
-- code_runner：代码运行，需要安装judge0填写url和key
-- divination：占卜，填写openai格式的api和url可以和主模型一致
-- create_art：绘画能力暂时仅支持fal(https://fal.ai/)的模型,还需填写一个openai格式模型用于提示词生成
-- get_weather_data：天气信息，对接oenweather(https://openweathermap.org/api/one-call-3)
-- jina_fact_checking/jina_reader/jina_search: jina的模型https://jina.ai/
-- picture_api：随机图片
-```
+## 🔗 相关项目
 
+-   [NoneBot2](https://github.com/nonebot/nonebot2)
+-   [LangGraph](https://github.com/langchain-ai/langgraph)
+-   [LangChain](https://github.com/langchain-ai/langchain)
+-   [Judge0](https://github.com/judge0/judge0)
+-   [Memos](https://github.com/usememos/memos)
 
-## tools
+## 📄 许可证
 
-### 安装code_runner的judge0
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FMgrsc%2FLLMQ-Horizon.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FMgrsc%2FLLMQ-Horizon?ref=badge_large&issueType=license)
 
-参考https://github.com/judge0/judge0/blob/master/CHANGELOG.md
-我们建议使用 Ubuntu 22.04，在此系统上您需要进行以下 GRUB 更新(改为cgroup v1)：
-```
-使用 sudo 打开文件 /etc/default/grub
-在 GRUB_CMDLINE_LINUX 变量的值中添加 systemd.unified_cgroup_hierarchy=0。
-应用更改：sudo update-grub
-重启您的服务器：sudo reboot
-```
-部署步骤:
-下载并解压发行版压缩包：
-```
-wget https://github.com/judge0/judge0/releases/download/v1.13.1/judge0-v1.13.1.zip
-unzip judge0-v1.13.1.zip
-```
-访问[此网站](https://www.random.org/passwords/?num=1&len=32&format=plain&rnd=new)以生成随机密码。
-使用生成的密码更新 judge0.conf 文件中的 REDIS_PASSWORD 变量。
-再次访问[此网站](https://www.random.org/passwords/?num=1&len=32&format=plain&rnd=new)以生成另一个随机密码。
-使用生成的密码更新 judge0.conf 文件中的 POSTGRES_PASSWORD 变量。
-运行所有服务并等待几秒钟，直到所有内容都初始化完成：
-```
-cd judge0-v1.13.1
-docker-compose up -d db redis
-sleep 10s
-docker-compose up -d
-sleep 5s
-```
-您的 Judge0 CE v1.13.1 实例现已启动并运行；访问 http://<您的服务器 IP 地址>:2358/docs 获取文档。
+本项目采用 [MIT 许可证](https://github.com/Mgrsc/LLMQ-Horizon/blob/main/LICENSE)。
+
+Copyright © 2024 Bitfennec.
+
+---
diff --git a/static/LLMQ.webp b/static/LLMQ.webp
diff --git a/static/qrcode.jpg b/static/qrcode.jpg