Merge branch 'rc/new-plugin' into refactor/new-plugin-system

pkg/pipeline/bansess/bansess.py

@@ -6,9 +6,9 @@ import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
 
 @stage.stage_class('BanSessionCheckStage')
 class BanSessionCheckStage(stage.PipelineStage):
-    """访问控制处理阶段
+    """Access control processing stage
 
-    仅检查query中群号或个人号是否在访问控制列表中。
+    Only check if the group or personal number in the query is in the access control list.
     """
 
     async def initialize(self, pipeline_config: dict):
@@ -41,5 +41,7 @@ class BanSessionCheckStage(stage.PipelineStage):
         return entities.StageProcessResult(
             result_type=entities.ResultType.CONTINUE if ctn else entities.ResultType.INTERRUPT,
             new_query=query,
-            console_notice=f'根据访问控制忽略消息: {query.launcher_type.value}_{query.launcher_id}' if not ctn else '',
+            console_notice=f'Ignore message according to access control: {query.launcher_type.value}_{query.launcher_id}'
+            if not ctn
+            else '',
         )

pkg/pipeline/cntfilter/filter.py

@@ -13,13 +13,13 @@ preregistered_filters: list[typing.Type[ContentFilter]] = []
 def filter_class(
     name: str,
 ) -> typing.Callable[[typing.Type[ContentFilter]], typing.Type[ContentFilter]]:
-    """内容过滤器类装饰器
+    """Content filter class decorator
 
     Args:
-        name (str): 过滤器名称
+        name (str): Filter name
 
     Returns:
-        typing.Callable[[typing.Type[ContentFilter]], typing.Type[ContentFilter]]: 装饰器
+        typing.Callable[[typing.Type[ContentFilter]], typing.Type[ContentFilter]]: Decorator
     """
 
     def decorator(cls: typing.Type[ContentFilter]) -> typing.Type[ContentFilter]:
@@ -35,7 +35,7 @@ def filter_class(
 
 
 class ContentFilter(metaclass=abc.ABCMeta):
-    """内容过滤器抽象类"""
+    """Content filter abstract class"""
 
     name: str
 
@@ -46,31 +46,31 @@ class ContentFilter(metaclass=abc.ABCMeta):
 
     @property
     def enable_stages(self):
-        """启用的阶段
+        """Enabled stages
 
-        默认为消息请求AI前后的两个阶段。
+        Default is the two stages before and after the message request to AI.
 
-        entity.EnableStage.PRE: 消息请求AI前，此时需要检查的内容是用户的输入消息。
-        entity.EnableStage.POST: 消息请求AI后，此时需要检查的内容是AI的回复消息。
+        entity.EnableStage.PRE: Before message request to AI, the content to check is the user's input message.
+        entity.EnableStage.POST: After message request to AI, the content to check is the AI's reply message.
         """
         return [entities.EnableStage.PRE, entities.EnableStage.POST]
 
     async def initialize(self):
-        """初始化过滤器"""
+        """Initialize filter"""
         pass
 
     @abc.abstractmethod
     async def process(self, query: pipeline_query.Query, message: str = None, image_url=None) -> entities.FilterResult:
         """处理消息
 
-        分为前后阶段，具体取决于 enable_stages 的值。
-        对于内容过滤器来说，不需要考虑消息所处的阶段，只需要检查消息内容即可。
+        It is divided into two stages, depending on the value of enable_stages.
+        For content filters, you do not need to consider the stage of the message, you only need to check the message content.
 
         Args:
-            message (str): 需要检查的内容
-            image_url (str): 要检查的图片的 URL
+            message (str): Content to check
+            image_url (str): URL of the image to check
 
         Returns:
-            entities.FilterResult: 过滤结果，具体内容请查看 entities.FilterResult 类的文档
+            entities.FilterResult: Filter result, please refer to the documentation of entities.FilterResult class
         """
         raise NotImplementedError

pkg/pipeline/cntfilter/filters/banwords.py

@@ -8,7 +8,7 @@ import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
 
 @filter_model.filter_class('ban-word-filter')
 class BanWordFilter(filter_model.ContentFilter):
-    """根据内容过滤"""
+    """Filter content"""
 
     async def initialize(self):
         pass

pkg/pipeline/cntfilter/filters/cntignore.py

@@ -8,7 +8,7 @@ import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
 
 @filter_model.filter_class('content-ignore')
 class ContentIgnore(filter_model.ContentFilter):
-    """根据内容忽略消息"""
+    """Ignore message according to content"""
 
     @property
     def enable_stages(self):
@@ -24,7 +24,7 @@ class ContentIgnore(filter_model.ContentFilter):
                         level=entities.ResultLevel.BLOCK,
                         replacement='',
                         user_notice='',
-                        console_notice='根据 ignore_rules 中的 prefix 规则，忽略消息',
+                        console_notice='Ignore message according to prefix rule in ignore_rules',
                     )
 
         if 'regexp' in query.pipeline_config['trigger']['ignore-rules']:
@@ -34,7 +34,7 @@ class ContentIgnore(filter_model.ContentFilter):
                         level=entities.ResultLevel.BLOCK,
                         replacement='',
                         user_notice='',
-                        console_notice='根据 ignore_rules 中的 regexp 规则，忽略消息',
+                        console_notice='Ignore message according to regexp rule in ignore_rules',
                     )
 
         return entities.FilterResult(

pkg/pipeline/longtext/longtext.py

@@ -15,9 +15,9 @@ importutil.import_modules_in_pkg(strategies)
 
 @stage.stage_class('LongTextProcessStage')
 class LongTextProcessStage(stage.PipelineStage):
-    """长消息处理阶段
+    """Long message processing stage
 
-    改写：
+    Rewrite:
         - resp_message_chain
     """
 
@@ -35,22 +35,22 @@ class LongTextProcessStage(stage.PipelineStage):
                         use_font = 'C:/Windows/Fonts/msyh.ttc'
                         if not os.path.exists(use_font):
                             self.ap.logger.warn(
-                                '未找到字体文件，且无法使用Windows自带字体，更换为转发消息组件以发送长消息，您可以在配置文件中调整相关设置。'
+                                'Font file not found, and Windows system font cannot be used, switch to forward message component to send long messages, you can adjust the related settings in the configuration file.'
                             )
                             config['blob_message_strategy'] = 'forward'
                         else:
-                            self.ap.logger.info('使用Windows自带字体：' + use_font)
+                            self.ap.logger.info('Using Windows system font: ' + use_font)
                             config['font-path'] = use_font
                     else:
                         self.ap.logger.warn(
-                            '未找到字体文件，且无法使用系统自带字体，更换为转发消息组件以发送长消息，您可以在配置文件中调整相关设置。'
+                            'Font file not found, and system font cannot be used, switch to forward message component to send long messages, you can adjust the related settings in the configuration file.'
                         )
 
                         pipeline_config['output']['long-text-processing']['strategy'] = 'forward'
             except Exception:
                 traceback.print_exc()
                 self.ap.logger.error(
-                    '加载字体文件失败({})，更换为转发消息组件以发送长消息，您可以在配置文件中调整相关设置。'.format(
+                    'Failed to load font file ({}), switch to forward message component to send long messages, you can adjust the related settings in the configuration file.'.format(
                         use_font
                     )
                 )
@@ -62,7 +62,7 @@ class LongTextProcessStage(stage.PipelineStage):
                 self.strategy_impl = strategy_cls(self.ap)
                 break
         else:
-            raise ValueError(f'未找到名为 {config["strategy"]} 的长消息处理策略')
+            raise ValueError(f'Long message processing strategy not found: {config["strategy"]}')
 
         await self.strategy_impl.initialize()
 
@@ -76,7 +76,7 @@ class LongTextProcessStage(stage.PipelineStage):
                 break
 
         if contains_non_plain:
-            self.ap.logger.debug('消息中包含非 Plain 组件，跳过长消息处理。')
+            self.ap.logger.debug('Message contains non-Plain components, skip long message processing.')
         elif (
             len(str(query.resp_message_chain[-1]))
             > query.pipeline_config['output']['long-text-processing']['threshold']

pkg/pipeline/longtext/strategies/forward.py

@@ -15,17 +15,17 @@ Forward = platform_message.Forward
 class ForwardComponentStrategy(strategy_model.LongTextStrategy):
     async def process(self, message: str, query: pipeline_query.Query) -> list[platform_message.MessageComponent]:
         display = ForwardMessageDiaplay(
-            title='群聊的聊天记录',
-            brief='[聊天记录]',
-            source='聊天记录',
-            preview=['QQ用户: ' + message],
-            summary='查看1条转发消息',
+            title='Group chat history',
+            brief='[Chat history]',
+            source='Chat history',
+            preview=['User: ' + message],
+            summary='View 1 forwarded message',
         )
 
         node_list = [
             platform_message.ForwardMessageNode(
                 sender_id=query.adapter.bot_account_id,
-                sender_name='QQ用户',
+                sender_name='User',
                 message_chain=platform_message.MessageChain([message]),
             )
         ]

pkg/pipeline/longtext/strategy.py

@@ -15,13 +15,13 @@ preregistered_strategies: list[typing.Type[LongTextStrategy]] = []
 def strategy_class(
     name: str,
 ) -> typing.Callable[[typing.Type[LongTextStrategy]], typing.Type[LongTextStrategy]]:
-    """长文本处理策略类装饰器
+    """Long text processing strategy class decorator
 
     Args:
-        name (str): 策略名称
+        name (str): Strategy name
 
     Returns:
-        typing.Callable[[typing.Type[LongTextStrategy]], typing.Type[LongTextStrategy]]: 装饰器
+        typing.Callable[[typing.Type[LongTextStrategy]], typing.Type[LongTextStrategy]]: Decorator
     """
 
     def decorator(cls: typing.Type[LongTextStrategy]) -> typing.Type[LongTextStrategy]:
@@ -37,7 +37,7 @@ def strategy_class(
 
 
 class LongTextStrategy(metaclass=abc.ABCMeta):
-    """长文本处理策略抽象类"""
+    """Long text processing strategy abstract class"""
 
     name: str
 
@@ -53,13 +53,13 @@ class LongTextStrategy(metaclass=abc.ABCMeta):
     async def process(self, message: str, query: pipeline_query.Query) -> list[platform_message.MessageComponent]:
         """处理长文本
 
-        在 platform.json 中配置 long-text-process 字段，只要 文本长度超过了 threshold 就会调用此方法
+        If the text length exceeds the threshold, this method will be called.
 
         Args:
-            message (str): 消息
-            query (core_entities.Query): 此次请求的上下文对象
+            message (str): Message
+            query (core_entities.Query): Query object
 
         Returns:
-            list[platform_message.MessageComponent]: 转换后的 平台 消息组件列表
+            list[platform_message.MessageComponent]: Converted platform message components
         """
         return []

pkg/pipeline/msgtrun/msgtrun.py

@@ -11,9 +11,9 @@ importutil.import_modules_in_pkg(truncators)
 
 @stage.stage_class('ConversationMessageTruncator')
 class ConversationMessageTruncator(stage.PipelineStage):
-    """会话消息截断器
+    """Conversation message truncator
 
-    用于截断会话消息链，以适应平台消息长度限制。
+    Used to truncate the conversation message chain to adapt to the LLM message length limit.
     """
 
     trun: truncator.Truncator
@@ -26,7 +26,7 @@ class ConversationMessageTruncator(stage.PipelineStage):
                 self.trun = trun(self.ap)
                 break
         else:
-            raise ValueError(f'未知的截断器: {use_method}')
+            raise ValueError(f'Unknown truncator: {use_method}')
 
     async def process(self, query: pipeline_query.Query, stage_inst_name: str) -> entities.StageProcessResult:
         """处理"""

pkg/pipeline/msgtrun/truncators/round.py

@@ -6,7 +6,7 @@ import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
 
 @truncator.truncator_class('round')
 class RoundTruncator(truncator.Truncator):
-    """前文回合数阶段器"""
+    """Truncate the conversation message chain to adapt to the LLM message length limit."""
 
     async def truncate(self, query: pipeline_query.Query) -> pipeline_query.Query:
         """截断"""
@@ -16,7 +16,7 @@ class RoundTruncator(truncator.Truncator):
 
         current_round = 0
 
-        # 从后往前遍历
+        # Traverse from back to front
         for msg in query.messages[::-1]:
             if current_round < max_round:
                 temp_messages.append(msg)

pkg/pipeline/pipelinemgr.py

@@ -97,12 +97,20 @@ class RuntimePipeline:
                 query.message_event, platform_events.GroupMessage
             ):
                 result.user_notice.insert(0, platform_message.At(query.message_event.sender.id))
-
-            await query.adapter.reply_message(
-                message_source=query.message_event,
-                message=result.user_notice,
-                quote_origin=query.pipeline_config['output']['misc']['quote-origin'],
-            )
+            if await query.adapter.is_stream_output_supported():
+                await query.adapter.reply_message_chunk(
+                    message_source=query.message_event,
+                    bot_message=query.resp_messages[-1],
+                    message=result.user_notice,
+                    quote_origin=query.pipeline_config['output']['misc']['quote-origin'],
+                    is_final=[msg.is_final for msg in query.resp_messages][0],
+                )
+            else:
+                await query.adapter.reply_message(
+                    message_source=query.message_event,
+                    message=result.user_notice,
+                    quote_origin=query.pipeline_config['output']['misc']['quote-origin'],
+                )
         if result.debug_notice:
             self.ap.logger.debug(result.debug_notice)
         if result.console_notice:
@@ -148,23 +156,27 @@ class RuntimePipeline:
                 result = await result
 
             if isinstance(result, pipeline_entities.StageProcessResult):  # 直接返回结果
-                self.ap.logger.debug(f'Stage {stage_container.inst_name} processed query {query} res {result}')
+                self.ap.logger.debug(
+                    f'Stage {stage_container.inst_name} processed query {query.query_id} res {result.result_type}'
+                )
                 await self._check_output(query, result)
 
                 if result.result_type == pipeline_entities.ResultType.INTERRUPT:
-                    self.ap.logger.debug(f'Stage {stage_container.inst_name} interrupted query {query}')
+                    self.ap.logger.debug(f'Stage {stage_container.inst_name} interrupted query {query.query_id}')
                     break
                 elif result.result_type == pipeline_entities.ResultType.CONTINUE:
                     query = result.new_query
             elif isinstance(result, typing.AsyncGenerator):  # 生成器
-                self.ap.logger.debug(f'Stage {stage_container.inst_name} processed query {query} gen')
+                self.ap.logger.debug(f'Stage {stage_container.inst_name} processed query {query.query_id} gen')
 
                 async for sub_result in result:
-                    self.ap.logger.debug(f'Stage {stage_container.inst_name} processed query {query} res {sub_result}')
+                    self.ap.logger.debug(
+                        f'Stage {stage_container.inst_name} processed query {query.query_id} res {sub_result.result_type}'
+                    )
                     await self._check_output(query, sub_result)
 
                     if sub_result.result_type == pipeline_entities.ResultType.INTERRUPT:
-                        self.ap.logger.debug(f'Stage {stage_container.inst_name} interrupted query {query}')
+                        self.ap.logger.debug(f'Stage {stage_container.inst_name} interrupted query {query.query_id}')
                         break
                     elif sub_result.result_type == pipeline_entities.ResultType.CONTINUE:
                         query = sub_result.new_query
@@ -196,7 +208,7 @@ class RuntimePipeline:
             if event_ctx.is_prevented_default():
                 return
 
-            self.ap.logger.debug(f'Processing query {query}')
+            self.ap.logger.debug(f'Processing query {query.query_id}')
 
             await self._execute_from_stage(0, query)
         except Exception as e:
@@ -204,7 +216,7 @@ class RuntimePipeline:
             self.ap.logger.error(f'处理请求时出错 query_id={query.query_id} stage={inst_name} : {e}')
             self.ap.logger.error(f'Traceback: {traceback.format_exc()}')
         finally:
-            self.ap.logger.debug(f'Query {query} processed')
+            self.ap.logger.debug(f'Query {query.query_id} processed')
             del self.ap.query_pool.cached_queries[query.query_id]
 
 

pkg/pipeline/preproc/preproc.py

@@ -11,11 +11,11 @@ import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
 
 @stage.stage_class('PreProcessor')
 class PreProcessor(stage.PipelineStage):
-    """请求预处理阶段
+    """Request pre-processing stage
 
-    签出会话、prompt、上文、模型、内容函数。
+    Check out session, prompt, context, model, and content functions.
 
-    改写：
+    Rewrite:
         - session
         - prompt
         - messages
@@ -29,12 +29,12 @@ class PreProcessor(stage.PipelineStage):
         query: pipeline_query.Query,
         stage_inst_name: str,
     ) -> entities.StageProcessResult:
-        """处理"""
+        """Process"""
         selected_runner = query.pipeline_config['ai']['runner']['runner']
 
         session = await self.ap.sess_mgr.get_session(query)
 
-        # 非 local-agent 时，llm_model 为 None
+        # When not local-agent, llm_model is None
         llm_model = (
             await self.ap.model_mgr.get_model_by_uuid(query.pipeline_config['ai']['local-agent']['model'])
             if selected_runner == 'local-agent'
@@ -80,7 +80,7 @@ class PreProcessor(stage.PipelineStage):
                         if me.type == 'image_url':
                             msg.content.remove(me)
 
-        content_list = []
+        content_list: list[provider_message.ContentElement] = []
 
         plain_text = ''
         qoute_msg = query.pipeline_config['trigger'].get('misc', '').get('combine-quote-message')

pkg/pipeline/process/handler.py

@@ -25,7 +25,7 @@ class MessageHandler(metaclass=abc.ABCMeta):
 
     def cut_str(self, s: str) -> str:
         """
-        取字符串第一行，最多20个字符，若有多行，或超过20个字符，则加省略号
+        Take the first line of the string, up to 20 characters, if there are multiple lines, or more than 20 characters, add an ellipsis
         """
         s0 = s.split('\n')[0]
         if len(s0) > 20 or '\n' in s:

pkg/pipeline/process/handlers/chat.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import uuid
 import typing
 import traceback
 
@@ -48,7 +49,6 @@ class ChatMessageHandler(handler.MessageHandler):
         if event_ctx.is_prevented_default():
             if event_ctx.event.reply is not None:
                 mc = platform_message.MessageChain(event_ctx.event.reply)
-
                 query.resp_messages.append(mc)
 
                 yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
@@ -60,6 +60,10 @@ class ChatMessageHandler(handler.MessageHandler):
                 query.user_message.content = event_ctx.event.alter
 
             text_length = 0
+            try:
+                is_stream = await query.adapter.is_stream_output_supported()
+            except AttributeError:
+                is_stream = False
 
             try:
                 for r in runner_module.preregistered_runners:
@@ -68,21 +72,41 @@ class ChatMessageHandler(handler.MessageHandler):
                         break
                 else:
                     raise ValueError(f'未找到请求运行器: {query.pipeline_config["ai"]["runner"]["runner"]}')
+                if is_stream:
+                    resp_message_id = uuid.uuid4()
+                    await query.adapter.create_message_card(str(resp_message_id), query.message_event)
+                    async for result in runner.run(query):
+                        result.resp_message_id = str(resp_message_id)
+                        if query.resp_messages:
+                            query.resp_messages.pop()
+                        if query.resp_message_chain:
+                            query.resp_message_chain.pop()
 
-                async for result in runner.run(query):
-                    query.resp_messages.append(result)
+                        query.resp_messages.append(result)
+                        self.ap.logger.info(f'对话({query.query_id})流式响应: {self.cut_str(result.readable_str())}')
 
-                    self.ap.logger.info(f'对话({query.query_id})响应: {self.cut_str(result.readable_str())}')
+                        if result.content is not None:
+                            text_length += len(result.content)
 
-                    if result.content is not None:
-                        text_length += len(result.content)
+                        yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
 
-                    yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
+                else:
+                    async for result in runner.run(query):
+                        query.resp_messages.append(result)
+
+                        self.ap.logger.info(f'对话({query.query_id})响应: {self.cut_str(result.readable_str())}')
+
+                        if result.content is not None:
+                            text_length += len(result.content)
+
+                        yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
 
                 query.session.using_conversation.messages.append(query.user_message)
+
                 query.session.using_conversation.messages.extend(query.resp_messages)
             except Exception as e:
                 self.ap.logger.error(f'对话({query.query_id})请求失败: {type(e).__name__} {str(e)}')
+                traceback.print_exc()
 
                 hide_exception_info = query.pipeline_config['output']['misc']['hide-exception']
 

pkg/pipeline/process/handlers/command.py

@@ -16,7 +16,7 @@ class CommandHandler(handler.MessageHandler):
         self,
         query: pipeline_query.Query,
     ) -> typing.AsyncGenerator[entities.StageProcessResult, None]:
-        """处理"""
+        """Process"""
 
         command_text = str(query.message_chain).strip()[1:]
 
@@ -71,7 +71,7 @@ class CommandHandler(handler.MessageHandler):
                         )
                     )
 
-                    self.ap.logger.info(f'命令({query.query_id})报错: {self.cut_str(str(ret.error))}')
+                    self.ap.logger.info(f'Command({query.query_id}) error: {self.cut_str(str(ret.error))}')
 
                     yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
                 elif ret.text is not None or ret.image_url is not None:
@@ -90,7 +90,7 @@ class CommandHandler(handler.MessageHandler):
                         )
                     )
 
-                    self.ap.logger.info(f'命令返回: {self.cut_str(str(content[0]))}')
+                    self.ap.logger.info(f'Command returned: {self.cut_str(str(content[0]))}')
 
                     yield entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)
                 else:

pkg/pipeline/process/process.py

@@ -33,11 +33,11 @@ class Processor(stage.PipelineStage):
         query: pipeline_query.Query,
         stage_inst_name: str,
     ) -> entities.StageProcessResult:
-        """处理"""
+        """Process"""
         message_text = str(query.message_chain).strip()
 
         self.ap.logger.info(
-            f'处理 {query.launcher_type.value}_{query.launcher_id} 的请求({query.query_id}): {message_text}'
+            f'Processing request from {query.launcher_type.value}_{query.launcher_id} ({query.query_id}): {message_text}'
         )
 
         async def generator():

pkg/pipeline/respback/respback.py

@@ -6,6 +6,7 @@ import asyncio
 
 import langbot_plugin.api.entities.builtin.platform.events as platform_events
 import langbot_plugin.api.entities.builtin.platform.message as platform_message
+import langbot_plugin.api.entities.builtin.provider.message as provider_message
 
 from .. import stage, entities
 import langbot_plugin.api.entities.builtin.pipeline.query as pipeline_query
@@ -36,10 +37,22 @@ class SendResponseBackStage(stage.PipelineStage):
 
         quote_origin = query.pipeline_config['output']['misc']['quote-origin']
 
-        await query.adapter.reply_message(
-            message_source=query.message_event,
-            message=query.resp_message_chain[-1],
-            quote_origin=quote_origin,
-        )
+        has_chunks = any(isinstance(msg, provider_message.MessageChunk) for msg in query.resp_messages)
+        # TODO 命令与流式的兼容性问题
+        if await query.adapter.is_stream_output_supported() and has_chunks:
+            is_final = [msg.is_final for msg in query.resp_messages][0]
+            await query.adapter.reply_message_chunk(
+                message_source=query.message_event,
+                bot_message=query.resp_messages[-1],
+                message=query.resp_message_chain[-1],
+                quote_origin=quote_origin,
+                is_final=is_final,
+            )
+        else:
+            await query.adapter.reply_message(
+                message_source=query.message_event,
+                message=query.resp_message_chain[-1],
+                quote_origin=quote_origin,
+            )
 
         return entities.StageProcessResult(result_type=entities.ResultType.CONTINUE, new_query=query)