mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-10-30 11:54:50 +08:00
6d4ce83837
严格检查全部宿主源码，清零类型错误预算并移除按模块类型豁免。 按原因、所属方法、错误码及语法指纹锁定必要兼容例外和站点类型桩， CI 阻断新增忽略、检查范围退化、本地桩替代真实接口及新的类型错误。 修复空值、异步和供应方类型边界，保持插件与 API 兼容合同， 并补充存储、订阅、通知、Agent 和工作流边界的回归覆盖。
253 lines
8.3 KiB
Python
253 lines
8.3 KiB
Python
"""
|
|
让用户通过按钮进行选择的工具。
|
|
"""
|
|
|
|
from typing import Any, List, Optional, Type
|
|
|
|
from pydantic import BaseModel, Field, model_validator
|
|
|
|
from app.agent.tools.base import MoviePilotTool
|
|
from app.agent.tools.tags import ToolTag
|
|
from app.application.messaging.interaction.agent import (
|
|
AgentInteractionOption,
|
|
agent_interaction_manager,
|
|
build_agent_choice_callback,
|
|
)
|
|
from app.runtime.log import logger
|
|
from app.schemas.message import Message
|
|
from app.schemas.notification import ChannelCapabilityManager
|
|
from app.schemas.types import MessageType, NotificationChannel
|
|
|
|
|
|
class UserChoiceOptionInput(BaseModel):
|
|
"""
|
|
单个按钮选项。
|
|
"""
|
|
|
|
label: str = Field(
|
|
...,
|
|
description="按钮上显示的文本",
|
|
)
|
|
value: str = Field(
|
|
...,
|
|
description="用户点击后原样作为下一条消息返回给智能体的内容",
|
|
)
|
|
|
|
@model_validator(mode="after")
|
|
def validate_option(self) -> "UserChoiceOptionInput":
|
|
"""
|
|
校验按钮选项的文案和值不能为空。
|
|
"""
|
|
label = str(self.label)
|
|
value = str(self.value)
|
|
if not label.strip():
|
|
raise ValueError("label 不能为空")
|
|
if not value.strip():
|
|
raise ValueError("value 不能为空")
|
|
return self
|
|
|
|
|
|
class AskUserChoiceInput(BaseModel):
|
|
"""
|
|
按钮选择工具输入。
|
|
"""
|
|
|
|
message: str = Field(
|
|
...,
|
|
description="与按钮一同展示给用户的问题或提示",
|
|
)
|
|
title: Optional[str] = Field(
|
|
None,
|
|
description="问题上方可选的简短标题",
|
|
)
|
|
options: List[UserChoiceOptionInput] = Field(
|
|
...,
|
|
description="展示给用户的按钮选项列表",
|
|
)
|
|
|
|
@model_validator(mode="after")
|
|
def validate_payload(self) -> "AskUserChoiceInput":
|
|
"""
|
|
校验按钮选择工具必须提供问题和选项。
|
|
"""
|
|
message = str(self.message)
|
|
if not message.strip():
|
|
raise ValueError("message 不能为空")
|
|
if not self.options:
|
|
raise ValueError("options 至少需要提供一个")
|
|
return self
|
|
|
|
|
|
class AskUserChoiceTool(MoviePilotTool):
|
|
"""
|
|
发送按钮选择并让当前 Agent 轮次等待用户回调消息。
|
|
"""
|
|
|
|
name: str = Field(
|
|
default="ask_user_choice",
|
|
description="供模型调用的稳定工具名称",
|
|
)
|
|
tags: list[str] = Field(
|
|
default=[ToolTag.Write, ToolTag.Message, ToolTag.UserInteraction, ToolTag.TerminalResponse],
|
|
description="工具的能力和权限分类标签，初始化时会统一归一化",
|
|
)
|
|
sends_message: bool = Field(
|
|
default=True,
|
|
description="工具是否直接向当前用户发送消息",
|
|
)
|
|
return_direct: bool = Field(
|
|
default=True,
|
|
description="是否直接返回工具结果并结束本轮智能体响应",
|
|
)
|
|
description: str = Field(
|
|
default=(
|
|
"在支持交互按钮的渠道中请用户选择选项。"
|
|
"本工具结束当前交互轮次：在本次调用中提供完整问题和全部选项，随后停止本轮。"
|
|
"用户点击按钮后，所选值会作为下一条用户消息返回。"
|
|
"不要再以纯文本重复发送同一问题。"
|
|
),
|
|
description="供模型理解工具用途、输入约束和调用边界的说明",
|
|
)
|
|
args_schema: Type[BaseModel] = Field(
|
|
default=AskUserChoiceInput,
|
|
description="工具输入参数的验证模型或 JSON Schema",
|
|
)
|
|
|
|
def get_tool_message(self, **kwargs: Any) -> Optional[str]:
|
|
"""
|
|
生成工具执行提示文案。
|
|
"""
|
|
message = kwargs.get("message", "") or ""
|
|
if len(message) > 40:
|
|
message = message[:40] + "..."
|
|
return f"发送按钮选择: {message}"
|
|
|
|
@staticmethod
|
|
def _truncate_button_text(text: str, max_length: int) -> str:
|
|
"""
|
|
按渠道限制截断按钮文案。
|
|
"""
|
|
if max_length <= 0 or len(text) <= max_length:
|
|
return text
|
|
if max_length <= 3:
|
|
return text[:max_length]
|
|
return text[: max_length - 3] + "..."
|
|
|
|
def _blocked_by_feedback_quality_gate(self) -> bool:
|
|
"""
|
|
反馈 Issue 质量门槛拒绝后，禁止继续发按钮引导改写。
|
|
|
|
这是对 ``feedback-issue`` skill 的历史兜底：如果同一轮上下文已经
|
|
标记反馈内容被质量门槛拒绝，就不能再用按钮诱导用户把测试 / 占位
|
|
内容改写成“真实问题”。
|
|
"""
|
|
return bool(self._agent_context.get("feedback_issue_rejected_quality"))
|
|
|
|
async def run( # type: ignore[override]
|
|
self,
|
|
message: str,
|
|
options: List[UserChoiceOptionInput],
|
|
title: Optional[str] = None,
|
|
**kwargs: Any,
|
|
) -> str:
|
|
"""
|
|
发送按钮选择消息，并登记待回调的交互上下文。
|
|
|
|
:param message: 展示给用户的问题
|
|
:param options: 可点击的选项列表
|
|
:param title: 可选标题
|
|
:return: 工具执行结果描述
|
|
"""
|
|
if self._blocked_by_feedback_quality_gate():
|
|
logger.warning(
|
|
"ask_user_choice blocked after feedback issue rejected_quality: "
|
|
"session_id=%s",
|
|
self._session_id,
|
|
)
|
|
return (
|
|
"反馈 Issue 已被质量门槛拒绝，不能继续发送按钮引导用户改写或重新提交。"
|
|
"请直接结束本次反馈流程。"
|
|
)
|
|
|
|
if not self._channel or not self._source:
|
|
return "当前不在可回传消息的会话中，无法发起按钮选择"
|
|
|
|
try:
|
|
channel = NotificationChannel(self._channel)
|
|
except ValueError:
|
|
return f"不支持的消息渠道: {self._channel}"
|
|
|
|
if not (
|
|
ChannelCapabilityManager.supports_buttons(channel)
|
|
and ChannelCapabilityManager.supports_callbacks(channel)
|
|
):
|
|
return f"当前渠道 {channel.value} 不支持按钮选择"
|
|
|
|
max_per_row = 1
|
|
max_rows = ChannelCapabilityManager.get_max_button_rows(channel)
|
|
max_text_length = ChannelCapabilityManager.get_max_button_text_length(channel)
|
|
max_options = max_per_row * max_rows
|
|
if len(options) > max_options:
|
|
return f"当前渠道最多支持 {max_options} 个按钮选项"
|
|
|
|
choice_options = [
|
|
AgentInteractionOption(
|
|
label=option.label.strip(),
|
|
value=option.value.strip(),
|
|
)
|
|
for option in options
|
|
]
|
|
request = agent_interaction_manager.create_request(
|
|
session_id=self._session_id,
|
|
user_id=str(self._user_id),
|
|
channel=channel.value,
|
|
source=self._source,
|
|
username=self._username,
|
|
title=title,
|
|
prompt=message.strip(),
|
|
options=choice_options,
|
|
)
|
|
|
|
buttons = []
|
|
current_row = []
|
|
for index, option in enumerate(choice_options, start=1):
|
|
current_row.append(
|
|
{
|
|
"text": self._truncate_button_text(option.label, max_text_length),
|
|
"callback_data": build_agent_choice_callback(
|
|
request.request_id, index
|
|
),
|
|
}
|
|
)
|
|
if len(current_row) >= max_per_row:
|
|
buttons.append(current_row)
|
|
current_row = []
|
|
if current_row:
|
|
buttons.append(current_row)
|
|
|
|
logger.info(
|
|
"执行工具: %s, channel=%s, session_id=%s, options=%s",
|
|
self.name,
|
|
channel.value,
|
|
self._session_id,
|
|
len(choice_options),
|
|
)
|
|
|
|
await self.send_message(
|
|
Message(
|
|
channel=channel,
|
|
source=self._source,
|
|
mtype=MessageType.Agent,
|
|
userid=self._user_id,
|
|
username=self._username,
|
|
title=title,
|
|
text=message.strip(),
|
|
buttons=buttons,
|
|
save_history=False,
|
|
)
|
|
)
|
|
|
|
self._agent_context["user_reply_sent"] = True
|
|
self._agent_context["reply_mode"] = "button_choice"
|
|
return f"已发送 {len(choice_options)} 个按钮选项，等待用户选择"
|