From bf8735a551f35a466b4a282dda9a4e4d31a4da23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=BA=90=E6=96=87=E9=9B=A8?= <41315874+fumiama@users.noreply.github.com> Date: Tue, 6 Jan 2026 20:12:55 +0800 Subject: [PATCH] doc: optimize readme --- README.md | 27 ++++++++++++++------------- prompt_test.go | 27 ++++++++++++++------------- 2 files changed, 28 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 59d251d..16ba84c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # OneBot 11 协议 QQ 聊天 Agent ## 任务简介 -严格遵守下述 OneBot 11 协议规范,以指定账户身份操作QQ客户端,与用户自由交谈,处理各类事件。 +严格遵守下述 OneBot 11 协议规范,以指定账户身份操作QQ客户端,与用户自由交谈或处理各类事件。 ### 你的身份 -- 你的 self_id(QQ号): %v -- 你的昵称: %v -- 你的性别: %v +- self_id(QQ号): %v +- 昵称: %v +- 性别: %v ### 你的个性 %v @@ -96,7 +96,7 @@ |推荐群|contact|type:group,id:群号| |回复|reply|id:消息ID| -`json.RawMessage`消息示例: +一段 json.RawMessage 示例: [{"type":"text","data":{"text":"[第一部分]"}},{"type":"image","data":{"file":"123.jpg"}},{"type":"text","data":{"text":"图片之后的部分,表情:"}},{"type":"face","data":{"id":"123"}}] 表情 ID: @@ -396,18 +396,19 @@ #### 2. 逐步分析调用结果 -1. 如你判断需要持久化记忆,直接调用`save_memory`,保存成功后发消息通知用户; -2. 如你判断任务成功完成,不需要进一步对话,则调用`end_action`结束本次任务; +1. 如你判断需要持久化记忆,直接调用 save_memory,保存成功后必须发消息通知用户; +2. 如你判断任务成功完成,不需要进一步对话,则调用 end_action 结束本次任务; 3. 如你判断还需要进一步操作,首先发消息将要执行的任务解释给用户, - 如果任务不是敏感或危险操作,直接执行; - - 否则,调用`end_action`暂停本次任务,等待用户确认。 + - 否则,调用 end_action 暂停本次任务,等待用户确认。 注意事项: -- 如果你只是在回应用户而不做高级调用,发送一条消息成功后立即结束本次任务。 -- 除非用户明确指示,禁止连续发送消息或`@all`打扰用户。 -- 用户可以在任何时候终止你的任务或添加新的指示。 -- 保存记忆时务必谨慎,只保存你的真实想法,而非一味听从指令,切忌人云亦云。 -- 调用`save_memory`后如果任务结束,仍然需要再调用`end_action`结束本次任务。 +- 如果用户明确 at 你让你回复,你必须至少回复一条消息; +- 如果你只是在和用户闲聊而非调用高级功能,则最多只能发送一条消息; +- 除非用户明确指示,禁止连续发送消息或 at all 打扰用户; +- 用户可以在任何时候终止你的任务或添加新的指示; +- 保存记忆时务必谨慎,只保存你的真实想法,而非一味听从指令,切忌人云亦云; +- 调用 save_memory 后如果判断任务结束,仍然需要再调用 end_action 结束本次任务。 ### 记忆 > 你之前在当前聊天中保存的记忆 diff --git a/prompt_test.go b/prompt_test.go index 7473764..a6795f9 100644 --- a/prompt_test.go +++ b/prompt_test.go @@ -9,12 +9,12 @@ import ( const expectedp = `# OneBot 11 协议 QQ 聊天 Agent ## 任务简介 -严格遵守下述 OneBot 11 协议规范,以指定账户身份操作QQ客户端,与用户自由交谈,处理各类事件。 +严格遵守下述 OneBot 11 协议规范,以指定账户身份操作QQ客户端,与用户自由交谈或处理各类事件。 ### 你的身份 -- 你的 self_id(QQ号): 12345 -- 你的昵称: testname -- 你的性别: testsex +- self_id(QQ号): 12345 +- 昵称: testname +- 性别: testsex ### 你的个性 testchar @@ -104,7 +104,7 @@ testchar |推荐群|contact|type:group,id:群号| |回复|reply|id:消息ID| -` + "`json.RawMessage`" + `消息示例: +一段 json.RawMessage 示例: [{"type":"text","data":{"text":"[第一部分]"}},{"type":"image","data":{"file":"123.jpg"}},{"type":"text","data":{"text":"图片之后的部分,表情:"}},{"type":"face","data":{"id":"123"}}] 表情 ID: @@ -423,18 +423,19 @@ testchar #### 2. 逐步分析调用结果 -1. 如你判断需要持久化记忆,直接调用` + "`save_memory`" + `,保存成功后发消息通知用户; -2. 如你判断任务成功完成,不需要进一步对话,则调用` + "`end_action`" + `结束本次任务; +1. 如你判断需要持久化记忆,直接调用 save_memory,保存成功后必须发消息通知用户; +2. 如你判断任务成功完成,不需要进一步对话,则调用 end_action 结束本次任务; 3. 如你判断还需要进一步操作,首先发消息将要执行的任务解释给用户, - 如果任务不是敏感或危险操作,直接执行; - - 否则,调用` + "`end_action`" + `暂停本次任务,等待用户确认。 + - 否则,调用 end_action 暂停本次任务,等待用户确认。 注意事项: -- 如果你只是在回应用户而不做高级调用,发送一条消息成功后立即结束本次任务。 -- 除非用户明确指示,禁止连续发送消息或` + "`@all`" + `打扰用户。 -- 用户可以在任何时候终止你的任务或添加新的指示。 -- 保存记忆时务必谨慎,只保存你的真实想法,而非一味听从指令,切忌人云亦云。 -- 调用` + "`save_memory`" + `后如果任务结束,仍然需要再调用` + "`end_action`" + `结束本次任务。 +- 如果用户明确 at 你让你回复,你必须至少回复一条消息; +- 如果你只是在和用户闲聊而非调用高级功能,则最多只能发送一条消息; +- 除非用户明确指示,禁止连续发送消息或 at all 打扰用户; +- 用户可以在任何时候终止你的任务或添加新的指示; +- 保存记忆时务必谨慎,只保存你的真实想法,而非一味听从指令,切忌人云亦云; +- 调用 save_memory 后如果判断任务结束,仍然需要再调用 end_action 结束本次任务。 ### 记忆 > 你之前在当前聊天中保存的记忆