docs(planner): 为规划器相关模块添加详细的文档字符串

为 `plan_executor`、`planner` 和 `planner_prompts` 模块中的类和函数补充了详细的文档字符串(docstrings)。

这提高了代码的可读性和可维护性,阐明了每个组件的职责、参数和返回值,使得其他开发者能更容易地理解和使用这些模块。
This commit is contained in:
minecraft1024a
2025-09-13 12:04:34 +08:00
parent 07f37323b2
commit f1c1a2081a
4 changed files with 100 additions and 10 deletions

View File

@@ -1,12 +1,21 @@
"""
本文件集中管理所有与规划器相关的提示词模板。
本文件集中管理所有与规划器Planner相关的提示词Prompt模板。
通过将提示词与代码逻辑分离,可以更方便地对模型的行为进行迭代和优化,
而无需修改核心代码。
"""
from src.chat.utils.prompt import Prompt
def init_prompts():
"""
初始化并注册所有规划器相关的提示词。
初始化并向 Prompt 注册系统注册所有规划器相关的提示词。
这个函数会在模块加载时自动调用,确保所有提示词在系统启动时都已准备就绪。
"""
# 核心规划器提示词,用于在接收到新消息时决定如何回应。
# 它构建了一个复杂的上下文,包括历史记录、可用动作、角色设定等,
# 并要求模型以 JSON 格式输出一个或多个动作组合。
Prompt(
"""
{schedule_block}
@@ -83,6 +92,8 @@ def init_prompts():
"planner_prompt",
)
# 主动思考规划器提示词,用于在没有新消息时决定是否要主动发起对话。
# 它模拟了人类的自发性思考,允许模型根据长期记忆和最近的对话来决定是否开启新话题。
Prompt(
"""
# 主动思考决策
@@ -140,6 +151,8 @@ def init_prompts():
"proactive_planner_prompt",
)
# 单个动作的格式化提示词模板。
# 用于将每个可用动作的信息格式化后,插入到主提示词的 {action_options_text} 占位符中。
Prompt(
"""
动作:{action_name}
@@ -154,5 +167,6 @@ def init_prompts():
"action_prompt",
)
# 在模块加载时自动初始化
# 在模块加载时自动调用,完成提示词的注册。
init_prompts()