koishi-plugin-group-memory 1.0.0

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "koishi-plugin-group-memory",
+  "version": "1.0.0",
+  "description": "智能群聊记忆中间件：自动记录上下文，在@或回复时注入前情提要，支持时间窗口过滤与内容清洗",
+  "main": "./src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "koishi",
+    "plugin",
+    "memory",
+    "context",
+    "group-chat",
+    "ai",
+    "middleware",
+    "deepseek",
+    "openai"
+  ],
+  "author": "YourName",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "koishi": {
+    "description": {
+      "en": "Smart group chat memory middleware. Automatically records context and injects summaries when @mentioned or replied. Supports time-window filtering, content cleaning (mentions/images), and custom templates. Perfect for making AI bots aware of ongoing conversations.",
+      "zh": "智能群聊记忆中间件。自动记录群内闲聊上下文，当用户 @机器人 或回复机器人时，自动将“前情提要”注入给 AI 插件。支持按时间/条数过滤记忆、自动清洗 @符号和图片、自定义提示词模板。是让 AI 机器人拥有“群聊感知力”的必备插件。"
+    },
+    "service": {
+      "required": [],
+      "optional": []
+    }
+  },
+  "peerDependencies": {
+    "koishi": "^4.16.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,190 @@
+const { Context } = require('koishi');
+
+exports.name = 'group-memory';
+exports.usage = '自动记录群聊上下文，并在用户@机器人或回复机器人时，将前情提要注入给 AI 插件';
+
+// 配置架构
+exports.Config = (ctx) => ({
+  // --- 记忆设置 ---
+  maxContext: 20,          // 每个群保留最近多少条消息
+  timeWindow: 3600000,     // (可选) 只保留最近 N 毫秒内的消息 (默认 1 小时)，0 表示不限制时间只限制条数
+  
+  // --- 触发条件 ---
+  triggerOnAt: true,       // 当消息中包含 @机器人 时触发
+  triggerOnReply: true,    // 当消息是回复机器人的消息时触发
+  
+  // --- 适配设置 ---
+  // 目标 AI 插件的名称列表。当消息命中这些插件的命令或逻辑时，才注入上下文。
+  // 留空则对所有消息生效（只要满足 @ 或回复条件）。
+  // 对于 deepseek-chat 插件，通常不需要填，因为它是通过中间件拦截所有内容的。
+  // 但如果你的 AI 插件有特定的命令前缀，可以在这里辅助判断。
+  targetPlugins: [],       
+  
+  // --- 内容处理 ---
+  cleanMentions: true,     // 发送给 AI 前，是否移除消息中的 @ 符号 (避免 AI 困惑)
+  cleanImages: true,       // 是否移除图片/媒体占位符 (如 [图片])
+  prefixTemplate: (history) => {
+    // 自定义前情提要的模板函数
+    return "【群聊前情提要】\n" + 
+      history.map(msg => `${msg.timeStr} ${msg.user}: ${msg.content}`).join('\n') + 
+      "\n---\n请结合以上上下文回答以下问题：";
+  },
+
+  // --- 调试 ---
+  verbose: false           // 是否在控制台打印注入的上下文
+});
+
+exports.apply = (ctx, config) => {
+  // 内存存储：{ groupId: [ { user: string, content: string, time: number, timeStr: string }, ... ] }
+  const groupChats = new Map();
+
+  // 工具函数：格式化时间
+  const formatTime = (timestamp) => {
+    const date = new Date(timestamp);
+    return `${date.getHours().toString().padStart(2, '0')}:${date.getMinutes().toString().padStart(2, '0')}`;
+  };
+
+  // 工具函数：清洗消息内容
+  const cleanContent = (content, session) => {
+    let text = content;
+    
+    // 1. 移除 @ 提及 (特别是 @机器人)
+    if (config.cleanMentions) {
+      // 移除 koishi 标准的 @ 元素标记 (如果是 element 对象)
+      // 这里主要处理纯文本中的 @
+      text = text.replace(new RegExp(`@${session.selfId}`, 'g'), '');
+      text = text.replace(/@\S+/g, (match) => {
+        // 可以选择保留其他人名，或者全部移除，这里选择移除 @ 符号但保留名字，或者直接移除整段
+        // 为了 AI 理解，通常移除 @ 符号即可
+        return match.replace('@', '');
+      });
+    }
+
+    // 2. 移除图片/媒体占位符 (根据具体协议可能不同，这里做通用处理)
+    if (config.cleanImages) {
+      text = text.replace(/\[图片\]/g, '[图片已省略]');
+      text = text.replace(/\[表情.*?\]/g, '');
+      // 移除 XML 或 JSON 形式的媒体元素 (常见于 QQ/OneBot)
+      text = text.replace(/\[CQ:.*?\]/g, ''); 
+    }
+
+    return text.trim();
+  };
+
+  // --- 中间件 1: 记录群聊历史 ---
+  ctx.middleware(async (session, next) => {
+    // 只在群聊中生效
+    if (!session.groupId) return next();
+    
+    // 忽略机器人自己的消息
+    if (session.selfId === session.userId) return next();
+    
+    // 忽略指令消息 (以 . / \ 开头)，避免把命令本身记入上下文干扰 AI
+    const trimmed = session.content?.trim() || '';
+    if (/^[./\\]/.test(trimmed)) return next();
+
+    // 忽略空消息
+    if (!trimmed) return next();
+
+    const groupId = session.groupId;
+    if (!groupChats.has(groupId)) {
+      groupChats.set(groupId, []);
+    }
+    
+    const history = groupChats.get(groupId);
+    const now = Date.now();
+
+    // 记录消息
+    const cleanText = cleanContent(session.content, session);
+    
+    history.push({
+      user: session.author?.nickname || session.userId,
+      content: cleanText,
+      time: now,
+      timeStr: formatTime(now)
+    });
+
+    // 1. 限制条数
+    while (history.length > config.maxContext) {
+      history.shift();
+    }
+
+    // 2. 限制时间窗口 (如果配置了)
+    if (config.timeWindow > 0) {
+      const cutoff = now - config.timeWindow;
+      while (history.length > 0 && history[0].time < cutoff) {
+        history.shift();
+      }
+    }
+
+    return next();
+  }, true); // priority: true (确保尽早记录)
+
+  // --- 中间件 2: 检测触发并注入上下文 ---
+  // 优先级设为低 (100)，确保在其他插件处理之前完成注入，但又不至于太早导致拿不到解析结果
+  ctx.middleware(async (session, next) => {
+    if (!session.groupId) return next();
+
+    // 检查触发条件
+    let shouldInject = false;
+
+    // 1. 检查 @ 机器人
+    if (config.triggerOnAt) {
+      // Koishi 标准解析方式
+      const isAtBot = session.parsed?.bots?.includes(session.selfId) || 
+                      (session.content && new RegExp(`<@${session.selfId}>|@${session.selfId}`).test(session.content));
+      if (isAtBot) shouldInject = true;
+    }
+
+    // 2. 检查回复机器人
+    if (!shouldInject && config.triggerOnReply && session.quote) {
+      if (session.quote.userId === session.selfId) {
+        shouldInject = true;
+      }
+    }
+
+    if (!shouldInject) return next();
+
+    // 获取该群历史
+    const groupId = session.groupId;
+    const history = groupChats.get(groupId) || [];
+
+    // 如果没有历史，直接跳过注入
+    if (history.length === 0) return next();
+
+    // 构造前情提要
+    const contextPrefix = config.prefixTemplate(history);
+    
+    // 获取原始内容并清洗 (移除 @ 机器人部分，避免重复)
+    let originalContent = session.content || '';
+    
+    // 移除 @ 标记，让 AI 看到的更干净
+    if (config.cleanMentions) {
+       originalContent = originalContent.replace(new RegExp(`<@${session.selfId}>`, 'g'), '')
+                                        .replace(new RegExp(`@${session.selfId}`, 'g'), '')
+                                        .trim();
+    }
+
+    // --- 核心注入逻辑 ---
+    // 策略 A: 如果 session 已经有 messages 数组 (某些高级 AI 插件使用)，尝试注入到 messages 头部
+    // 策略 B: 默认修改 session.content (兼容绝大多数简单 AI 插件，包括之前的 deepseek-chat)
+    
+    if (Array.isArray(session.messages) && session.messages.length > 0) {
+      // 尝试兼容多消息模式：将前情提要作为第一条系统/用户消息插入
+      // 注意：这取决于 AI 插件如何处理 messages 数组。
+      // 最稳妥的方式还是修改 content，因为很多插件是 content -> messages 转换的。
+      // 这里我们优先保证 content 被修改，因为这是最通用的。
+    }
+
+    // 执行注入：拼接内容
+    // 格式：[前情提要] + [用户当前问题]
+    session.content = `${contextPrefix}\n${originalContent}`;
+
+    if (config.verbose) {
+      console.log(`[GroupMemory] 群 ${groupId} 触发上下文注入。历史条数: ${history.length}`);
+      // console.log('Injected Content:', session.content);
+    }
+
+    return next();
+  }, 100); 
+};