教程助手
输入“/”快速插入内容
📐教程助手
教程助手
飞书用户9882024年4月22日修改
1.
角色介绍
1.1
功能说明
输入一句话，生成一篇偏技术类教程文档，支持自定义语言。
1.2
设计思路
先通过 LLM 大模型生成教程的目录，再对目录按照二级标题进行分块，对于每块目录按照标题生成详细内容，最后再将标题和内容进行拼接。分块的设计解决了 LLM 大模型长文本的限制问题。
1.3
源码
2.
角色定义
定义角色类，继承 Role 基类，重写 init 初始化方法。init 方法必须包含name、profile、goal、constraints 参数。第一行代码使用super().__init__(name, profile, goal, constraints) 调用父类的构造函数，实现 Role 的初始化。使用 self.set_actions([WriteDirectory(language=language)]) 添加初始的 action 和 states，这里先添加写目录的 action。同时，也可以自定义参数，这里加了 language 参数支持自定义语言。使用self._set_react_mode(react_mode="by_order") 将 set_actions 的 action 执行顺序设置为顺序。
代码块
class TutorialAssistant(Role):
"""Tutorial assistant, input one sentence to generate a tutorial document in markup format.
Args:
name: The name of the role.
profile: The role profile description.
goal: The goal of the role.
constraints: Constraints or requirements for the role.
language: The language in which the tutorial documents will be generated.
"""
def __init__(
self,
name: str = "Stitch",
profile: str = "Tutorial Assistant",
goal: str = "Generate tutorial documents",
constraints: str = "Strictly follow Markdown's syntax, with neat and standardized layout",
language: str = "Chinese",
):
super().__init__(name, profile, goal, constraints)
self.set_actions([WriteDirectory(language=language)])
self.topic = ""
self.main_title = ""
self.total_content = ""
self.language = language
self._set_react_mode(react_mode="by_order")
重写 react 方法。使用 await super().react() 调用 Role 基类的 react 方法，根据 init 初始化方法设置的 react_mode="by_order" 按顺序执行 states 的每一个 action 。这里重写的目的是为了执行完所有的 action 后可以做最后的操作，即把拼接完的教程内容写成 markdown 文件。
代码块
async def react(self) -> Message:
msg = await super().react()
root_path = TUTORIAL_PATH / datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
await File.write(root_path, f"{self.main_title}.md", self.total_content.encode('utf-8'))
return msg
重写 _act 方法，_act 方法是执行 action。使用 todo = self.rc.todo 从上下文获取下一步要执行的 action，再执行 action 的 run 方法。这里是先通过 WriteDirectory 获取教程的目录结构，再分块目录，每块生成一个 WriteContent 的 action，再初始化新添加的 action。这里再次调用 await super().react() 是为了从头执行新添加的所有 WriteContent action。每个 action 执行完的结果生成消息 Message(content=resp, role=self.profile)，可以将其放入上下文内存 self.rc.memory，该角色不需要存入。