Merge branch 'Developer' of https://github.com/JeffreySu/WeiXinMPSDK …

…into Developer
JeffreySu · May 24, 2024 · 636339a · 636339a
2 parents e7abb98 + 4016d82
commit 636339a
Showing 1 changed file with 51 additions and 2 deletions.
diff --git a/Samples with AI/readme.md b/Samples with AI/readme.md
@@ -8,7 +8,7 @@
 
 内容将涵盖：
 
-1. [ ] 微信公众号 Chat 机器人（文字）
+1. [X] 微信公众号 Chat 机器人（文字） - 已于 2024 年 5 月 25 日上线
 2. [ ] 微信公众号 Chat 机器人（图片）
 3. [ ] 微信公众号 Chat 机器人（多模态混合）
 4. [ ] 微信公众号带搜索功能的 Chat 机器人
@@ -21,4 +21,53 @@
 
 AI 功能将整合在 [/Samples/All/net8-mvc](../Samples/All/net8-mvc/Senparc.Weixin.Sample.Net8/) 集成案例中。
 
-更多说明将在对应功能上线后在本文档中补充。
+更多说明将在对应功能上线后在本文档中补充。
+
+## 【微信公众号 Chat 机器人（文字）】开发说明
+
+1. 使用常规步骤开发微信公众号
+2. 在 `OnTextRequestAsync` 事件中，加入对进入 AI 对话状态的激活关键字（从节约 AI 用量和用户体验，以及公众号实际功能考虑，建议不要始终保持 AI 对话），如：
+
+```
+.Keyword("AI", () => this.StartAIChatAsync().Result)
+```
+
+> [查看代码](https://github.com/JeffreySu/WeiXinMPSDK/blob/f28a5995b3e5f01b3be384b5c7462324ec6f0886/Samples/All/Senparc.Weixin.Sample.CommonService/MessageHandlers/CustomMessageHandler/CustomMessageHandler.cs#L194-L194)
+
+其中 `StartAIChatAsync()` 用于激活当前用户对话山下文的 AI 对话状态
+
+> [查看代码](https://github.com/JeffreySu/WeiXinMPSDK/blob/f28a5995b3e5f01b3be384b5c7462324ec6f0886/Samples/All/Senparc.Weixin.Sample.CommonService/AI/MessageHandlers/CustomMessageHandler_AI.cs#L41-L41)
+
+
+3. 为了能够让系统优先判断当前是否在 AI 状态，需要在上述代码执行前，加入尝试 AI 对话的代码，如：
+
+```
+var aiResponseMessage = await this.AIChatAsync(requestMessage);
+if (aiResponseMessage != null)
+{
+    return aiResponseMessage;
+}
+```
+
+> [查看代码](https://github.com/JeffreySu/WeiXinMPSDK/blob/f28a5995b3e5f01b3be384b5c7462324ec6f0886/Samples/All/Senparc.Weixin.Sample.CommonService/MessageHandlers/CustomMessageHandler/CustomMessageHandler.cs#L179-L179)
+
+其中 `AIChatAsync()` 方法用于提供尝试向 AI 发送对话消息的业务逻辑（如果不在对话状态则返回 null，程序继续执行常规代码）
+
+> [查看代码](https://github.com/JeffreySu/WeiXinMPSDK/blob/f28a5995b3e5f01b3be384b5c7462324ec6f0886/Samples/All/Senparc.Weixin.Sample.CommonService/AI/MessageHandlers/CustomMessageHandler_AI.cs#L41-L41)
+
+4. 配置 AI 参数，请参考 `Senparc.AI 【开发过程】第一步：配置账号`，在 appsettings.json 文件中追加 ”SenparcAiSetting“ 节点（[查看](https://github.com/Senparc/Senparc.AI/blob/main/README.md#%E7%AC%AC%E4%B8%80%E6%AD%A5%E9%85%8D%E7%BD%AE%E8%B4%A6%E5%8F%B7)）（注意：通常只需设置其中一种平台的配置）
+
+5. 引用 Senparc.AI.Kernel 包，并在启动代码中激活 Senparc.AI：
+
+```
+services.AddSenparcAI(Configuration) // 注册 AI
+```
+
+> [查看代码](https://github.com/JeffreySu/WeiXinMPSDK/blob/f28a5995b3e5f01b3be384b5c7462324ec6f0886/Samples/All/net8-mvc/Senparc.Weixin.Sample.Net8/Startup.cs#L88-L88)
+
+```
+registerService.UseSenparcAI();// 启用 AI
+```
+
+> [查看代码](https://github.com/JeffreySu/WeiXinMPSDK/blob/f28a5995b3e5f01b3be384b5c7462324ec6f0886/Samples/All/net8-mvc/Senparc.Weixin.Sample.Net8/Startup.cs#L452-L452)
+