Merge pull request #1113 from haoxiuwen/doc-v2

Add Conversation Summary Plugin Docs

docs/.vuepress/sidebar/document.ts

@@ -363,6 +363,7 @@ const documentSidebar = [
       { text: '即时通讯 REST API 概览', link: 'overview.html' },
       { 
         text: '消息管理', 
+        collapsible: true,
         children: [
           { text: '发送单聊消息', link: 'message_single.html' },
           { text: '发送群聊消息', link: 'message_group.html' },
@@ -380,6 +381,7 @@ const documentSidebar = [
       },
       { 
         text: '群组',
+        collapsible: true,
         children: [
           { text: '管理群组', link: 'group_manage.html' },
           { text: '管理群组文件', link: 'group_file.html' },
@@ -400,6 +402,7 @@ const documentSidebar = [
       },
       { 
         text: '聊天室',
+        collapsible: true,
         children: [
           { text: '管理超级管理员', link: 'chatroom_superadmin.html' },
           { text: '管理聊天室', link: 'chatroom_manage.html' },
@@ -420,6 +423,7 @@ const documentSidebar = [
       },
       { 
         text: '用户相关',
+        collapsible: true,
         children: [
           { text: '用户体系管理', link: 'account_system.html' },
           { text: '用户属性', link: 'userprofile.html' },
@@ -431,6 +435,7 @@ const documentSidebar = [
       },
       { 
         text: '离线推送',
+        collapsible: true,
         children: [
           { text: '离线推送设置', link: 'push.html' },
           { text: '离线推送的消息扩展', link: 'push_extension.html' },
@@ -442,6 +447,7 @@ const documentSidebar = [
   },
   {
     text: 'Server SDK',
+    collapsible: true,
     children: [
       { text: 'Java Server SDK 2.0', link: 'java_server_sdk_2.0.html' },
       { text: 'Java Server SDK 1.0', link: 'java_server_sdk.html' },
@@ -458,6 +464,7 @@ const documentSidebar = [
   },
   {
     text: '设置回调',
+    collapsible: true,
     children: [
       { text: '回调概述', link: 'callback_overview.html' },
       { text: '发送前回调', link: 'callback_presending.html' },

docs/.vuepress/sidebar/index.ts

@@ -17,6 +17,7 @@ export const zhSidebar = sidebar({
           children: 子菜单。请参考「子菜单示例」
       */
       text: "产品简介",
+      collapsible: true,
       children: [
         { text: "产品概述", link: "introduction.html" },
         { text: "特性介绍",
@@ -64,12 +65,14 @@ export const zhSidebar = sidebar({
     },
     {
       text: "Demo",
+      collapsible: true,
       children: [
         { text: "Demo 体验及源码地址", link: "demo_sourcecode_address.html" },
       ],
     },
     {
       text: "内容审核",
+      collapsible: true,
       children: [
         {
           text: "产品简介",
@@ -148,6 +151,7 @@ export const zhSidebar = sidebar({
     },
     {
       text: "场景方案",
+      collapsible: true,
       children: [
         {
           text: "环信 AIGC",
@@ -247,7 +251,7 @@ export const zhSidebar = sidebar({
             },
             {
               text: "API 参考",
-              collapsible: false,
+              collapsible: true,
               children: [
                 { text: "REST 社区管理", link: "circle/server_mgmt_rest.html" },
                 {
@@ -318,8 +322,22 @@ export const zhSidebar = sidebar({
         },
       ],
     },
+    {
+      text: 'AI 会话摘要助手',
+      collapsible: true,
+      children: [
+        { text: '效果展示及开通', link: 'plug-in/conversation_summary_enable.html' },
+        { text: '集成指南', 
+          collapsible: true,
+          children: [
+            { text: "RESTful API", link: "plug-in/conversation_summary_restful.html" },
+          ],  
+        },
+      ], 
+    },
     {
       text: "常见方案",
+      collapsible: true,
       children: [
         { text: "群 @ 消息", link: "solution_common/[email protected]" },
         { text: "消息引用", link: "solution_common/message_quote.html" },
@@ -329,6 +347,7 @@ export const zhSidebar = sidebar({
     },
     {
       text: "FAQ",
+      collapsible: true,
       children: [
         { text: "FAQ 质量", link: "faq_quality_issues.html" },
         { text: "FAQ 集成", link: "faq_integration_issues.html" },
@@ -337,13 +356,15 @@ export const zhSidebar = sidebar({
     },
     {
       text: "安全",
+      collapsible: true,
       children: [
         { text: "安全最佳实践", link: "security_best_practices.html" },
         { text: "GDPR 安全合规", link: "GDPR.html" },
       ],
     },
     {
       text: "Console 指南",
+      collapsible: true,
       children: [
         { text: "开通和配置服务", link: "enable_and_configure_IM.html" },
         { text: "消息量统计", link: "message_statistics.html" },

docs/product/limitationapi.md

@@ -272,3 +272,11 @@
 | 设置推送消息展示方式 | PUT  | /{org_name}/{app_name}/users/{userId} | 
 
 以上两个接口的总调用频率（默认值）为 100 次/秒/App Key。
+
+## AI 会话摘要助手
+
+| RESTful API 接口        | 方法 | 接口 URL           | 接口最高调用频率（默认值） |
+| :----------- | :--- | :------------- | :----------- |
+| 生成会话摘要         | POST  | /{org_name}/{app_name}/agent/v1/messages/summary | 100 次/秒/App Key          |
+| 获取会话摘要         | GET  | /{org_name}/{app_name}/agent/v1/messages/summaries?conversationId={groupId}&username={username}&chatType={chatType} | 100 次/秒/App Key          |
+| 删除会话摘要         | DELETE  | /{org_name}/{app_name}/agent/v1/messages/summary/{summaryId}?conversationId={groupId}&username={username}&chatType={chatType} | 100 次/秒/App Key          |

docs/product/plug-in/conversation_summary_enable.md

@@ -0,0 +1,35 @@
+# AI 会话摘要插件
+
+环信即时通讯 IM 提供群组会话摘要插件，通过 AI 技术针对单个群组会话中一段时间内的消息内容生成会话摘要，按话题详细列明讨论内容，包括话题标题、概要内容、相关消息条数及参与人人数及列表，支持用户一键跳转到首条消息，便于精读原文。该插件可帮助用户快速浏览大量未读消息，减少信息遗漏，助力用户高效获取关键信息，提升群聊体验。
+
+## 效果展示
+
+你可以点击[这里](https://console5-hsb.easemob.com)，体验 Web Demo，感受高效的聊天摘要功能。
+
+下图为集成会话摘要插件后的示例效果： 
+
+![img](/images/product/ai/conversation_summary_demo1.png)
+
+## 开通功能
+
+开通会话摘要插件前，确保你已成为环信的付费客户（已订阅专业版或旗舰版）且已开通消息漫游服务。
+
+你可以按以下步骤在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
+
+1. 在环信即时通讯云的左侧导航栏中，选择 **即时通讯** > **AI 智能** > **AI 会话摘要助手**，点击**去配置**按钮。
+
+![img](/images/product/ai/conversation_summary_configure.png)
+
+2. 在**功能配置总览** > **基础功能** 页面，点击 **AI会话摘要助手**一栏中的**免费开通**。
+
+![img](/images/product/ai/conversation_summary_enable.png)
+
+3. 选择 **即时通讯** > **AI 智能** > **AI 会话摘要助手**，进行助手设置。
+
+- 若选择**环信免费账户**，可免费试用 7 天，每天最多可调用 100 次 [RESTful API 生成会话摘要](conversation_summary_restful.html#生成会话摘要)，该额度每日 00:00 刷新，未使用部分将清零且不累积。
+- 若选择 **OpenAI** 或 **MiniMax**，需要配置你的**模型设置**和 **API 密钥**。配置后，可点击**验证**，检验你的配置是否正确。
+
+![img](/images/product/ai/conversation_summary_use.png)
+
+
+