AstrBot 4.10.2__py3-none-any.whl → 4.10.4__py3-none-any.whl

astrbot/builtin_stars/astrbot/long_term_memory.py

@@ -0,0 +1,186 @@
+import datetime
+import random
+import uuid
+from collections import defaultdict
+
+from astrbot import logger
+from astrbot.api import star
+from astrbot.api.event import AstrMessageEvent
+from astrbot.api.message_components import At, Image, Plain
+from astrbot.api.platform import MessageType
+from astrbot.api.provider import LLMResponse, Provider, ProviderRequest
+from astrbot.core.astrbot_config_mgr import AstrBotConfigManager
+
+"""
+聊天记忆增强
+"""
+
+
+class LongTermMemory:
+    def __init__(self, acm: AstrBotConfigManager, context: star.Context):
+        self.acm = acm
+        self.context = context
+        self.session_chats = defaultdict(list)
+        """记录群成员的群聊记录"""
+
+    def cfg(self, event: AstrMessageEvent):
+        cfg = self.context.get_config(umo=event.unified_msg_origin)
+        try:
+            max_cnt = int(cfg["provider_ltm_settings"]["group_message_max_cnt"])
+        except BaseException as e:
+            logger.error(e)
+            max_cnt = 300
+        image_caption_prompt = cfg["provider_settings"]["image_caption_prompt"]
+        image_caption_provider_id = cfg["provider_ltm_settings"].get(
+            "image_caption_provider_id"
+        )
+        image_caption = cfg["provider_ltm_settings"]["image_caption"] and bool(
+            image_caption_provider_id
+        )
+        active_reply = cfg["provider_ltm_settings"]["active_reply"]
+        enable_active_reply = active_reply.get("enable", False)
+        ar_method = active_reply["method"]
+        ar_possibility = active_reply["possibility_reply"]
+        ar_prompt = active_reply.get("prompt", "")
+        ar_whitelist = active_reply.get("whitelist", [])
+        ret = {
+            "max_cnt": max_cnt,
+            "image_caption": image_caption,
+            "image_caption_prompt": image_caption_prompt,
+            "image_caption_provider_id": image_caption_provider_id,
+            "enable_active_reply": enable_active_reply,
+            "ar_method": ar_method,
+            "ar_possibility": ar_possibility,
+            "ar_prompt": ar_prompt,
+            "ar_whitelist": ar_whitelist,
+        }
+        return ret
+
+    async def remove_session(self, event: AstrMessageEvent) -> int:
+        cnt = 0
+        if event.unified_msg_origin in self.session_chats:
+            cnt = len(self.session_chats[event.unified_msg_origin])
+            del self.session_chats[event.unified_msg_origin]
+        return cnt
+
+    async def get_image_caption(
+        self,
+        image_url: str,
+        image_caption_provider_id: str,
+        image_caption_prompt: str,
+    ) -> str:
+        if not image_caption_provider_id:
+            provider = self.context.get_using_provider()
+        else:
+            provider = self.context.get_provider_by_id(image_caption_provider_id)
+            if not provider:
+                raise Exception(f"没有找到 ID 为 {image_caption_provider_id} 的提供商")
+        if not isinstance(provider, Provider):
+            raise Exception(f"提供商类型错误({type(provider)})，无法获取图片描述")
+        response = await provider.text_chat(
+            prompt=image_caption_prompt,
+            session_id=uuid.uuid4().hex,
+            image_urls=[image_url],
+            persist=False,
+        )
+        return response.completion_text
+
+    async def need_active_reply(self, event: AstrMessageEvent) -> bool:
+        cfg = self.cfg(event)
+        if not cfg["enable_active_reply"]:
+            return False
+        if event.get_message_type() != MessageType.GROUP_MESSAGE:
+            return False
+
+        if event.is_at_or_wake_command:
+            # if the message is a command, let it pass
+            return False
+
+        if cfg["ar_whitelist"] and (
+            event.unified_msg_origin not in cfg["ar_whitelist"]
+            and (
+                event.get_group_id() and event.get_group_id() not in cfg["ar_whitelist"]
+            )
+        ):
+            return False
+
+        match cfg["ar_method"]:
+            case "possibility_reply":
+                trig = random.random() < cfg["ar_possibility"]
+                return trig
+
+        return False
+
+    async def handle_message(self, event: AstrMessageEvent):
+        """仅支持群聊"""
+        if event.get_message_type() == MessageType.GROUP_MESSAGE:
+            datetime_str = datetime.datetime.now().strftime("%H:%M:%S")
+
+            parts = [f"[{event.message_obj.sender.nickname}/{datetime_str}]: "]
+
+            cfg = self.cfg(event)
+
+            for comp in event.get_messages():
+                if isinstance(comp, Plain):
+                    parts.append(f" {comp.text}")
+                elif isinstance(comp, Image):
+                    if cfg["image_caption"]:
+                        try:
+                            url = comp.url if comp.url else comp.file
+                            if not url:
+                                raise Exception("图片 URL 为空")
+                            caption = await self.get_image_caption(
+                                url,
+                                cfg["image_caption_provider_id"],
+                                cfg["image_caption_prompt"],
+                            )
+                            parts.append(f" [Image: {caption}]")
+                        except Exception as e:
+                            logger.error(f"获取图片描述失败: {e}")
+                    else:
+                        parts.append(" [Image]")
+                elif isinstance(comp, At):
+                    parts.append(f" [At: {comp.name}]")
+
+            final_message = "".join(parts)
+            logger.debug(f"ltm | {event.unified_msg_origin} | {final_message}")
+            self.session_chats[event.unified_msg_origin].append(final_message)
+            if len(self.session_chats[event.unified_msg_origin]) > cfg["max_cnt"]:
+                self.session_chats[event.unified_msg_origin].pop(0)
+
+    async def on_req_llm(self, event: AstrMessageEvent, req: ProviderRequest):
+        """当触发 LLM 请求前，调用此方法修改 req"""
+        if event.unified_msg_origin not in self.session_chats:
+            return
+
+        chats_str = "\n---\n".join(self.session_chats[event.unified_msg_origin])
+
+        cfg = self.cfg(event)
+        if cfg["enable_active_reply"]:
+            prompt = req.prompt
+            req.prompt = (
+                f"You are now in a chatroom. The chat history is as follows:\n{chats_str}"
+                f"\nNow, a new message is coming: `{prompt}`. "
+                "Please react to it. Only output your response and do not output any other information. "
+                "You MUST use the SAME language as the chatroom is using."
+            )
+            req.contexts = []  # 清空上下文，当使用了主动回复，所有聊天记录都在一个prompt中。
+        else:
+            req.system_prompt += (
+                "You are now in a chatroom. The chat history is as follows: \n"
+            )
+            req.system_prompt += chats_str
+
+    async def after_req_llm(self, event: AstrMessageEvent, llm_resp: LLMResponse):
+        if event.unified_msg_origin not in self.session_chats:
+            return
+
+        if llm_resp.completion_text:
+            final_message = f"[You/{datetime.datetime.now().strftime('%H:%M:%S')}]: {llm_resp.completion_text}"
+            logger.debug(
+                f"Recorded AI response: {event.unified_msg_origin} | {final_message}"
+            )
+            self.session_chats[event.unified_msg_origin].append(final_message)
+            cfg = self.cfg(event)
+            if len(self.session_chats[event.unified_msg_origin]) > cfg["max_cnt"]:
+                self.session_chats[event.unified_msg_origin].pop(0)

astrbot/builtin_stars/astrbot/main.py

@@ -0,0 +1,120 @@
+import traceback
+
+from astrbot.api import star
+from astrbot.api.event import AstrMessageEvent, filter
+from astrbot.api.message_components import Image, Plain
+from astrbot.api.provider import LLMResponse, ProviderRequest
+from astrbot.core import logger
+
+from .long_term_memory import LongTermMemory
+from .process_llm_request import ProcessLLMRequest
+
+
+class Main(star.Star):
+    def __init__(self, context: star.Context) -> None:
+        self.context = context
+        self.ltm = None
+        try:
+            self.ltm = LongTermMemory(self.context.astrbot_config_mgr, self.context)
+        except BaseException as e:
+            logger.error(f"聊天增强 err: {e}")
+
+        self.proc_llm_req = ProcessLLMRequest(self.context)
+
+    def ltm_enabled(self, event: AstrMessageEvent):
+        ltmse = self.context.get_config(umo=event.unified_msg_origin)[
+            "provider_ltm_settings"
+        ]
+        return ltmse["group_icl_enable"] or ltmse["active_reply"]["enable"]
+
+    @filter.platform_adapter_type(filter.PlatformAdapterType.ALL)
+    async def on_message(self, event: AstrMessageEvent):
+        """群聊记忆增强"""
+        has_image_or_plain = False
+        for comp in event.message_obj.message:
+            if isinstance(comp, Plain) or isinstance(comp, Image):
+                has_image_or_plain = True
+                break
+
+        if self.ltm_enabled(event) and self.ltm and has_image_or_plain:
+            need_active = await self.ltm.need_active_reply(event)
+
+            group_icl_enable = self.context.get_config()["provider_ltm_settings"][
+                "group_icl_enable"
+            ]
+            if group_icl_enable:
+                """记录对话"""
+                try:
+                    await self.ltm.handle_message(event)
+                except BaseException as e:
+                    logger.error(e)
+
+            if need_active:
+                """主动回复"""
+                provider = self.context.get_using_provider(event.unified_msg_origin)
+                if not provider:
+                    logger.error("未找到任何 LLM 提供商。请先配置。无法主动回复")
+                    return
+                try:
+                    conv = None
+                    session_curr_cid = await self.context.conversation_manager.get_curr_conversation_id(
+                        event.unified_msg_origin,
+                    )
+
+                    if not session_curr_cid:
+                        logger.error(
+                            "当前未处于对话状态，无法主动回复，请确保 平台设置->会话隔离(unique_session) 未开启，并使用 /switch 序号 切换或者 /new 创建一个会话。",
+                        )
+                        return
+
+                    conv = await self.context.conversation_manager.get_conversation(
+                        event.unified_msg_origin,
+                        session_curr_cid,
+                    )
+
+                    prompt = event.message_str
+
+                    if not conv:
+                        logger.error("未找到对话，无法主动回复")
+                        return
+
+                    yield event.request_llm(
+                        prompt=prompt,
+                        func_tool_manager=self.context.get_llm_tool_manager(),
+                        session_id=event.session_id,
+                        conversation=conv,
+                    )
+                except BaseException as e:
+                    logger.error(traceback.format_exc())
+                    logger.error(f"主动回复失败: {e}")
+
+    @filter.on_llm_request()
+    async def decorate_llm_req(self, event: AstrMessageEvent, req: ProviderRequest):
+        """在请求 LLM 前注入人格信息、Identifier、时间、回复内容等 System Prompt"""
+        await self.proc_llm_req.process_llm_request(event, req)
+
+        if self.ltm and self.ltm_enabled(event):
+            try:
+                await self.ltm.on_req_llm(event, req)
+            except BaseException as e:
+                logger.error(f"ltm: {e}")
+
+    @filter.on_llm_response()
+    async def record_llm_resp_to_ltm(self, event: AstrMessageEvent, resp: LLMResponse):
+        """在 LLM 响应后记录对话"""
+        if self.ltm and self.ltm_enabled(event):
+            try:
+                await self.ltm.after_req_llm(event, resp)
+            except Exception as e:
+                logger.error(f"ltm: {e}")
+
+    @filter.after_message_sent()
+    async def after_message_sent(self, event: AstrMessageEvent):
+        """消息发送后处理"""
+        if self.ltm and self.ltm_enabled(event):
+            try:
+                clean_session = event.get_extra("_clean_ltm_session", False)
+                if clean_session:
+                    await self.ltm.remove_session(event)
+            except Exception as e:
+                logger.error(f"ltm: {e}")

astrbot/builtin_stars/astrbot/metadata.yaml

@@ -0,0 +1,4 @@
+name: astrbot
+desc: AstrBot 自带插件，包含人格注入、思考内容注入、群聊上下文感知等功能的实现，禁用后将无法使用这些功能。
+author: Soulter
+version: 4.1.0

astrbot/builtin_stars/astrbot/process_llm_request.py

@@ -0,0 +1,245 @@
+import builtins
+import copy
+import datetime
+import zoneinfo
+
+from astrbot.api import logger, sp, star
+from astrbot.api.event import AstrMessageEvent
+from astrbot.api.message_components import Image, Reply
+from astrbot.api.provider import Provider, ProviderRequest
+from astrbot.core.agent.message import TextPart
+from astrbot.core.provider.func_tool_manager import ToolSet
+
+
+class ProcessLLMRequest:
+    def __init__(self, context: star.Context):
+        self.ctx = context
+        cfg = context.get_config()
+        self.timezone = cfg.get("timezone")
+        if not self.timezone:
+            # 系统默认时区
+            self.timezone = None
+        else:
+            logger.info(f"Timezone set to: {self.timezone}")
+
+    async def _ensure_persona(self, req: ProviderRequest, cfg: dict, umo: str):
+        """确保用户人格已加载"""
+        if not req.conversation:
+            return
+        # persona inject
+
+        # custom rule is preferred
+        persona_id = (
+            await sp.get_async(
+                scope="umo", scope_id=umo, key="session_service_config", default={}
+            )
+        ).get("persona_id")
+
+        if not persona_id:
+            persona_id = req.conversation.persona_id or cfg.get("default_personality")
+            if not persona_id and persona_id != "[%None]":  # [%None] 为用户取消人格
+                default_persona = self.ctx.persona_manager.selected_default_persona_v3
+                if default_persona:
+                    persona_id = default_persona["name"]
+
+        persona = next(
+            builtins.filter(
+                lambda persona: persona["name"] == persona_id,
+                self.ctx.persona_manager.personas_v3,
+            ),
+            None,
+        )
+        if persona:
+            if prompt := persona["prompt"]:
+                req.system_prompt += prompt
+            if begin_dialogs := copy.deepcopy(persona["_begin_dialogs_processed"]):
+                req.contexts[:0] = begin_dialogs
+
+        # tools select
+        tmgr = self.ctx.get_llm_tool_manager()
+        if (persona and persona.get("tools") is None) or not persona:
+            # select all
+            toolset = tmgr.get_full_tool_set()
+            for tool in toolset:
+                if not tool.active:
+                    toolset.remove_tool(tool.name)
+        else:
+            toolset = ToolSet()
+            if persona["tools"]:
+                for tool_name in persona["tools"]:
+                    tool = tmgr.get_func(tool_name)
+                    if tool and tool.active:
+                        toolset.add_tool(tool)
+        req.func_tool = toolset
+        logger.debug(f"Tool set for persona {persona_id}: {toolset.names()}")
+
+    async def _ensure_img_caption(
+        self,
+        req: ProviderRequest,
+        cfg: dict,
+        img_cap_prov_id: str,
+    ):
+        try:
+            caption = await self._request_img_caption(
+                img_cap_prov_id,
+                cfg,
+                req.image_urls,
+            )
+            if caption:
+                req.extra_user_content_parts.append(
+                    TextPart(text=f"<image_caption>{caption}</image_caption>")
+                )
+                req.image_urls = []
+        except Exception as e:
+            logger.error(f"处理图片描述失败: {e}")
+
+    async def _request_img_caption(
+        self,
+        provider_id: str,
+        cfg: dict,
+        image_urls: list[str],
+    ) -> str:
+        if prov := self.ctx.get_provider_by_id(provider_id):
+            if isinstance(prov, Provider):
+                img_cap_prompt = cfg.get(
+                    "image_caption_prompt",
+                    "Please describe the image.",
+                )
+                logger.debug(f"Processing image caption with provider: {provider_id}")
+                llm_resp = await prov.text_chat(
+                    prompt=img_cap_prompt,
+                    image_urls=image_urls,
+                )
+                return llm_resp.completion_text
+            raise ValueError(
+                f"Cannot get image caption because provider `{provider_id}` is not a valid Provider, it is {type(prov)}.",
+            )
+        raise ValueError(
+            f"Cannot get image caption because provider `{provider_id}` is not exist.",
+        )
+
+    async def process_llm_request(self, event: AstrMessageEvent, req: ProviderRequest):
+        """在请求 LLM 前注入人格信息、Identifier、时间、回复内容等 System Prompt"""
+        cfg: dict = self.ctx.get_config(umo=event.unified_msg_origin)[
+            "provider_settings"
+        ]
+
+        # prompt prefix
+        if prefix := cfg.get("prompt_prefix"):
+            # 支持 {{prompt}} 作为用户输入的占位符
+            if "{{prompt}}" in prefix:
+                req.prompt = prefix.replace("{{prompt}}", req.prompt)
+            else:
+                req.prompt = prefix + req.prompt
+
+        # 收集系统提醒信息
+        system_parts = []
+
+        # user identifier
+        if cfg.get("identifier"):
+            user_id = event.message_obj.sender.user_id
+            user_nickname = event.message_obj.sender.nickname
+            system_parts.append(f"User ID: {user_id}, Nickname: {user_nickname}")
+
+        # group name identifier
+        if cfg.get("group_name_display") and event.message_obj.group_id:
+            if not event.message_obj.group:
+                logger.error(
+                    f"Group name display enabled but group object is None. Group ID: {event.message_obj.group_id}"
+                )
+                return
+            group_name = event.message_obj.group.group_name
+            if group_name:
+                system_parts.append(f"Group name: {group_name}")
+
+        # time info
+        if cfg.get("datetime_system_prompt"):
+            current_time = None
+            if self.timezone:
+                # 启用时区
+                try:
+                    now = datetime.datetime.now(zoneinfo.ZoneInfo(self.timezone))
+                    current_time = now.strftime("%Y-%m-%d %H:%M (%Z)")
+                except Exception as e:
+                    logger.error(f"时区设置错误: {e}, 使用本地时区")
+            if not current_time:
+                current_time = (
+                    datetime.datetime.now().astimezone().strftime("%Y-%m-%d %H:%M (%Z)")
+                )
+            system_parts.append(f"Current datetime: {current_time}")
+
+        img_cap_prov_id: str = cfg.get("default_image_caption_provider_id") or ""
+        if req.conversation:
+            # inject persona for this request
+            await self._ensure_persona(req, cfg, event.unified_msg_origin)
+
+            # image caption
+            if img_cap_prov_id and req.image_urls:
+                await self._ensure_img_caption(req, cfg, img_cap_prov_id)
+
+        # quote message processing
+        # 解析引用内容
+        quote = None
+        for comp in event.message_obj.message:
+            if isinstance(comp, Reply):
+                quote = comp
+                break
+        if quote:
+            content_parts = []
+
+            # 1. 处理引用的文本
+            sender_info = (
+                f"({quote.sender_nickname}): " if quote.sender_nickname else ""
+            )
+            message_str = quote.message_str or "[Empty Text]"
+            content_parts.append(f"{sender_info}{message_str}")
+
+            # 2. 处理引用的图片 (保留原有逻辑，但改变输出目标)
+            image_seg = None
+            if quote.chain:
+                for comp in quote.chain:
+                    if isinstance(comp, Image):
+                        image_seg = comp
+                        break
+
+            if image_seg:
+                try:
+                    # 找到可以生成图片描述的 provider
+                    prov = None
+                    if img_cap_prov_id:
+                        prov = self.ctx.get_provider_by_id(img_cap_prov_id)
+                    if prov is None:
+                        prov = self.ctx.get_using_provider(event.unified_msg_origin)
+
+                    # 调用 provider 生成图片描述
+                    if prov and isinstance(prov, Provider):
+                        llm_resp = await prov.text_chat(
+                            prompt="Please describe the image content.",
+                            image_urls=[await image_seg.convert_to_file_path()],
+                        )
+                        if llm_resp.completion_text:
+                            # 将图片描述作为文本添加到 content_parts
+                            content_parts.append(
+                                f"[Image Caption in quoted message]: {llm_resp.completion_text}"
+                            )
+                    else:
+                        logger.warning(
+                            "No provider found for image captioning in quote."
+                        )
+                except BaseException as e:
+                    logger.error(f"处理引用图片失败: {e}")
+
+            # 3. 将所有部分组合成文本并添加到 extra_user_content_parts 中
+            # 确保引用内容被正确的标签包裹
+            quoted_content = "\n".join(content_parts)
+            # 确保所有内容都在<Quoted Message>标签内
+            quoted_text = f"<Quoted Message>\n{quoted_content}\n</Quoted Message>"
+
+            req.extra_user_content_parts.append(TextPart(text=quoted_text))
+
+        # 统一包裹所有系统提醒
+        if system_parts:
+            system_content = (
+                "<system_reminder>" + "\n".join(system_parts) + "</system_reminder>"
+            )
+            req.extra_user_content_parts.append(TextPart(text=system_content))

astrbot/builtin_stars/builtin_commands/commands/__init__.py

@@ -0,0 +1,31 @@
+# Commands module
+
+from .admin import AdminCommands
+from .alter_cmd import AlterCmdCommands
+from .conversation import ConversationCommands
+from .help import HelpCommand
+from .llm import LLMCommands
+from .persona import PersonaCommands
+from .plugin import PluginCommands
+from .provider import ProviderCommands
+from .setunset import SetUnsetCommands
+from .sid import SIDCommand
+from .t2i import T2ICommand
+from .tool import ToolCommands
+from .tts import TTSCommand
+
+__all__ = [
+    "AdminCommands",
+    "AlterCmdCommands",
+    "ConversationCommands",
+    "HelpCommand",
+    "LLMCommands",
+    "PersonaCommands",
+    "PluginCommands",
+    "ProviderCommands",
+    "SIDCommand",
+    "SetUnsetCommands",
+    "T2ICommand",
+    "TTSCommand",
+    "ToolCommands",
+]

astrbot/builtin_stars/builtin_commands/commands/admin.py

@@ -0,0 +1,77 @@
+from astrbot.api import star
+from astrbot.api.event import AstrMessageEvent, MessageChain, MessageEventResult
+from astrbot.core.config.default import VERSION
+from astrbot.core.utils.io import download_dashboard
+
+
+class AdminCommands:
+    def __init__(self, context: star.Context):
+        self.context = context
+
+    async def op(self, event: AstrMessageEvent, admin_id: str = ""):
+        """授权管理员。op <admin_id>"""
+        if not admin_id:
+            event.set_result(
+                MessageEventResult().message(
+                    "使用方法: /op <id> 授权管理员；/deop <id> 取消管理员。可通过 /sid 获取 ID。",
+                ),
+            )
+            return
+        self.context.get_config()["admins_id"].append(str(admin_id))
+        self.context.get_config().save_config()
+        event.set_result(MessageEventResult().message("授权成功。"))
+
+    async def deop(self, event: AstrMessageEvent, admin_id: str = ""):
+        """取消授权管理员。deop <admin_id>"""
+        if not admin_id:
+            event.set_result(
+                MessageEventResult().message(
+                    "使用方法: /deop <id> 取消管理员。可通过 /sid 获取 ID。",
+                ),
+            )
+            return
+        try:
+            self.context.get_config()["admins_id"].remove(str(admin_id))
+            self.context.get_config().save_config()
+            event.set_result(MessageEventResult().message("取消授权成功。"))
+        except ValueError:
+            event.set_result(
+                MessageEventResult().message("此用户 ID 不在管理员名单内。"),
+            )
+
+    async def wl(self, event: AstrMessageEvent, sid: str = ""):
+        """添加白名单。wl <sid>"""
+        if not sid:
+            event.set_result(
+                MessageEventResult().message(
+                    "使用方法: /wl <id> 添加白名单；/dwl <id> 删除白名单。可通过 /sid 获取 ID。",
+                ),
+            )
+            return
+        cfg = self.context.get_config(umo=event.unified_msg_origin)
+        cfg["platform_settings"]["id_whitelist"].append(str(sid))
+        cfg.save_config()
+        event.set_result(MessageEventResult().message("添加白名单成功。"))
+
+    async def dwl(self, event: AstrMessageEvent, sid: str = ""):
+        """删除白名单。dwl <sid>"""
+        if not sid:
+            event.set_result(
+                MessageEventResult().message(
+                    "使用方法: /dwl <id> 删除白名单。可通过 /sid 获取 ID。",
+                ),
+            )
+            return
+        try:
+            cfg = self.context.get_config(umo=event.unified_msg_origin)
+            cfg["platform_settings"]["id_whitelist"].remove(str(sid))
+            cfg.save_config()
+            event.set_result(MessageEventResult().message("删除白名单成功。"))
+        except ValueError:
+            event.set_result(MessageEventResult().message("此 SID 不在白名单内。"))
+
+    async def update_dashboard(self, event: AstrMessageEvent):
+        """更新管理面板"""
+        await event.send(MessageChain().message("正在尝试更新管理面板..."))
+        await download_dashboard(version=f"v{VERSION}", latest=False)
+        await event.send(MessageChain().message("管理面板更新完成。"))