初始化

Author: shadow3aaa

README.md

@@ -4,6 +4,10 @@
 
 ## ✨ nonebot-plugin-nyaturingtest ✨
 
+#### **N**ot**Y**et**A**notherTurningTest
+
+[![GitHub Stars](https://img.shields.io/github/stars/shadow3aaa/nonebot-plugin-nyaturingtest?style=social)](
+
 <a href="./LICENSE">
     <img src="https://img.shields.io/github/license/shadow3aaa/nonebot-plugin-nyaturingtest.svg" alt="license">
 </a>
@@ -19,31 +23,42 @@
 </a>
 </div>
 
-> [!IMPORTANT]
-> **收藏项目** ～⭐️
-
-<img width="100%" src="https://starify.komoridevs.icu/api/starify?owner=shadow3aaa&repo=nonebot-plugin-nyaturingtest" alt="starify" />
+## 📖 介绍
 
+也许是个有情感的群聊天机器人？
 
-## 📖 介绍
+### 特点:
 
-这里是插件的详细介绍部分
+- 具有基于VAD三维情感模型情感模块
+- 具有基于向量搜索的长期记忆和知识
+- 能够从聊天信息中自主提取知识记忆
+- 能够考虑自身的情感状态和记忆自行选择要不要回复和回复内容，比较拟人
+- 能够对每个人类用户进行情感记忆
+- ~~不似人类~~
 
 ## 💿 安装
 
+> [!IMPORTANT]
+> 要使用本插件, 你至少需要
+>
+> - 一个有效的 openai 规范接口 api key (根据你的 base_url，可以不是 openai 的)
+> - 如果你的 openai api key 是从 google cloud 或者 azure, deepseek, 硅基流动，自己架设的 llm 服务等而非在 openai 申请的, 你需要在 `.env` 文件中配置 `nyaturingtest_chat_openai_base_url` 为对应的 api 地址
+> - 一个有效的硅基流动 api key 用于嵌入模型请求 (https://siliconflow.com/)
+
 <details open>
 <summary>使用 nb-cli 安装</summary>
 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
 
     nb plugin install nonebot-plugin-nyaturingtest --upgrade
+
 使用 **pypi** 源安装
 
     nb plugin install nonebot-plugin-nyaturingtest --upgrade -i "https://pypi.org/simple"
+
 使用**清华源**安装
 
     nb plugin install nonebot-plugin-nyaturingtest --upgrade -i "https://pypi.tuna.tsinghua.edu.cn/simple"
 
-
 </details>
 
 <details>
@@ -54,26 +69,32 @@
 <summary>uv</summary>
 
     uv add nonebot-plugin-nyaturingtest
+
 安装仓库 master 分支
 
     uv add git+https://github.com/shadow3aaa/nonebot-plugin-nyaturingtest@master
+
 </details>
 
 <details>
 <summary>pdm</summary>
 
     pdm add nonebot-plugin-nyaturingtest
+
 安装仓库 master 分支
 
     pdm add git+https://github.com/shadow3aaa/nonebot-plugin-nyaturingtest@master
+
 </details>
 <details>
 <summary>poetry</summary>
 
     poetry add nonebot-plugin-nyaturingtest
+
 安装仓库 master 分支
 
     poetry add git+https://github.com/shadow3aaa/nonebot-plugin-nyaturingtest@master
+
 </details>
 
 打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
@@ -82,21 +103,53 @@
 
 </details>
 
+## 📝 TODO
+
+- [ ] 权限控制
+- [ ] 更多可选的语言模型供应商
+- [ ] 更多可选的嵌入模型供应商
+- [ ] 支持更多平台(目前支持: Onebot v11)
+- [ ] 优化机器人效果
+  - [ ] 让回复机制更加拟人
+  - [ ] 让回复欲望更加拟人
+  - [ ] 优化情感反馈机制
+  - [ ] 支持视觉模型
+  - [ ] 优化记忆模块
+    - [ ] 优化长期记忆检索
+    - [ ] 优化遗忘机制
+    - [ ] 对话时进行场景感知性总结
+  - [ ] 支持多种语言
+
 ## ⚙️ 配置
 
-在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+在 nonebot2 项目的`.env`文件中添加下表中的配置
 
-| 配置项  | 必填  | 默认值 |   说明   |
-| :-----: | :---: | :----: | :------: |
-| 配置项1 |  是   |   无   | 配置说明 |
-| 配置项2 |  否   |   无   | 配置说明 |
+|                   配置项                    |             必填             |                    默认值                    |                   说明                   |
+| :-----------------------------------------: | :--------------------------: | :------------------------------------------: | :--------------------------------------: |
+|      nyaturingtest_chat_openai_api_key      |              是              |                      无                      |        openai api 接口的 api key         |
+|       nyaturingtest_chat_openai_model       |              否              |               "gpt-3.5-turbo"                |      openai api 接口请求的 模型名称      |
+|     nyaturingtest_chat_openai_base_url      |              否              | "https://api.openai.com/v1/chat/completions" |          openai 接口请求的 url           |
+|      nyaturingtest_chat_gemini_api_key      |              否              |                      无                      |        gemini api 接口的 api key         |
+| nyaturingtest_embedding_siliconflow_api_key |              是              |                      无                      | siliconflow(硅基流动) api 接口的 api key |
+|        nyaturingtest_enabled_groups         | 否(但是不填写此插件就无意义) |                `[]`\(空列表\)                |          仅在这些群组中启用插件          |
 
 ## 🎉 使用
+
 ### 指令表
-| 指令  | 权限  | 需要@ | 范围  |   说明   |
-| :---: | :---: | :---: | :---: | :------: |
-| 指令1 | 主人  |  否   | 私聊  | 指令说明 |
-| 指令2 | 群员  |  是   | 群聊  | 指令说明 |
+
+|             指令             |  权限  | 范围 |            说明            |
+| :--------------------------: | :----: | :--: | :------------------------: |
+| set_role <角色名> <角色设定> | 所有人 | 群聊 |          设置角色          |
+|             role             | 所有人 | 群聊 |        获取当前角色        |
+|             calm             | 所有人 | 群聊 |     冷静(强制归零情绪)     |
+|            reset             | 所有人 | 群聊 |          重置会话          |
+|            status            | 所有人 | 群聊 |          获取状态          |
+|           provider           | 所有人 | 群聊 |       获取当前提供商       |
+|    set_provider <提供者>     | 所有人 | 群聊 | 设置提供商 (gemini/openai) |
+|     add_knowledge <知识>     | 所有人 | 群聊 |          添加知识          |
+|             help             | 所有人 | 群聊 |        显示帮助信息        |
 
 ### 🎨 效果图
-如果有效果图的话
+
+别急
+

pyproject.toml

@@ -1,29 +1,30 @@
 [project]
 name = "nonebot-plugin-nyaturingtest"
 version = "0.1.0"
-description = "插件描述"
+description = "也许是个有情感的聊天机器人"
 readme = "README.md"
 authors = [{ name = "shadow3aaa", email = "[email protected]" }]
 urls = { Repository = "https://github.com/shadow3aaa/nonebot-plugin-nyaturingtest" }
 requires-python = ">=3.10,<3.13"
 dependencies = [
   "nonebot2>=2.4.2,<3.0.0",
-
-  "nonebot-plugin-localstore>=0.7.4,<1.0.0",  # 若不需要存储文件应删除
-  "nonebot-plugin-apscheduler>=0.5.0,<1.0.0", # 若不使用定时任务应删除
-  "nonebot-plugin-waiter>=0.8.1,<1.0.0",      # 若不使用增强版的 got-reject 会话控制应删除
-
-  "nonebot-plugin-uninfo>=0.7.3,<1.0.0",   # 若不使用多平台用户信息获取插件应删除
-  "nonebot-plugin-alconna>=0.57.2,<1.0.0", # 若不使用 alconna 跨平台命令解析拓展应删除
-  # "nonebot-adapter-onebot>=2.4.6,<3.0.0", # 仅 onebot 应取消注释
-
+  "nonebot-plugin-localstore>=0.7.4,<1.0.0",
+  "nonebot-plugin-uninfo>=0.7.3,<1.0.0",
+  "nonebot-adapter-onebot>=2.4.6,<3.0.0", # 仅 onebot 应取消注释
   "httpx>=0.27.0,<1.0.0",
+  "langchain>=0.3.25",
+  "requests>=2.32.3",
+  "faiss-cpu>=1.11.0",
+  "langchain-community>=0.3.23",
+  "openai>=1.77.0",
+  "google-genai>=1.14.0",
+  "asyncio>=3.4.3",
 ]
 
 [dependency-groups]
 dev = [
   "nonebot2[fastapi]>=2.4.2,<3.0.0",
-  "ruff>=0.11.6,<1.0.0",
+  "ruff>=0.11.8,<1.0.0",
   # "nonemoji>=0.1.4,<1.0.0", # 推荐全局安装 pipx install nonemoji
   # "pre-commit>=4.1.0",      # 推荐全局安装 pipx install pre-commit
 ]