@lobehub/chat 0.76.2 → 0.77.0

package/docs/{Plugin-Development.en-US.md → Plugin-Development.md}

@@ -6,9 +6,9 @@
 
 - [Custom Plugin Workflow](#custom-plugin-workflow)
 
-  - [1. Create and Start a Plugin Project](#1-create-and-start-a-plugin-project)
-  - [2. Add the Local Plugin in LobeChat Role Settings](#2-add-the-local-plugin-in-lobechat-role-settings)
-  - [3. Test the Plugin Functionality in a Session](#3-test-the-plugin-functionality-in-a-session)
+  - [**`1`** Create and Start a Plugin Project](#1-create-and-start-a-plugin-project)
+  - [**`2`** Add the Local Plugin in LobeChat Role Settings](#2-add-the-local-plugin-in-lobechat-role-settings)
+  - [**`3`** Test the Plugin Functionality in a Session](#3-test-the-plugin-functionality-in-a-session)
 
 - [Local Plugin Development](#local-plugin-development)
 
@@ -19,6 +19,10 @@
 
 - [Plugin Deployment and Publication](#plugin-deployment-and-publication)
 
+  - [Plugin Shield](#plugin-shield)
+
+- [Link](#link)
+
 ## Plugin Composition
 
 A LobeChat plugin consists of the following components:
@@ -30,11 +34,13 @@ A LobeChat plugin consists of the following components:
 - **Server-side**: Implement the API capabilities described in the manifest.
 - **Frontend UI** (optional): Implement the interface described in the manifest, which will be displayed in plugin messages to provide richer information display than plain text.
 
+<br/>
+
 ## Custom Plugin Workflow
 
 To integrate a plugin into LobeChat, you need to add and use a custom plugin in LobeChat. This section will guide you through the process.
 
-### 1. Create and Start a Plugin Project
+### **`1`** Create and Start a Plugin Project
 
 First, you need to create a plugin project locally. You can use the [lobe-chat-plugin-template][lobe-chat-plugin-template-url] template we have prepared:
 
@@ -49,31 +55,31 @@ When you see `ready started server on 0.0.0.0:3400, url: http://localhost:3400`,
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259526-9ef25272-4312-429b-93bc-a95515727ed3.png)
 
-### 2. Add the Local Plugin in LobeChat Role Settings
+### **`2`** Add the Local Plugin in LobeChat Role Settings
 
 Next, go to LobeChat, create a new assistant, and go to its session settings page:
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259643-1a9cc34a-76f3-4ccf-928b-129654670efd.png)
 
-Click the "Add" button on the right side of "Plugin List" to open the custom plugin add dialog:
+Click the <kbd>Add</kbd> button on the right side of "Plugin List" to open the custom plugin add dialog:
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259748-2ef6a244-39bb-483c-b359-f156ffcbe1a4.png)
 
-Enter `http://localhost:3400/manifest-dev.json` in the "Plugin Manifest URL" field, which is the URL of the locally started plugin manifest.
+Enter `http://localhost:3400/manifest-dev.json` in the `Plugin Manifest URL` field, which is the URL of the locally started plugin manifest.
 
-At this point, you should see that the identifier of the plugin has been automatically recognized as `chat-plugin-template`. Then fill in the remaining form fields (only the title is required) and click the "Save" button to complete the custom plugin addition.
+At this point, you should see that the identifier of the plugin has been automatically recognized as `chat-plugin-template`. Then fill in the remaining form fields (only the title is required) and click the <kbd>Save</kbd> button to complete the custom plugin addition.
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259964-59f4906d-ae2e-4ec0-8b43-db36871d0869.png)
 
-After adding the plugin, you can see the newly added plugin in the plugin list. If you need to modify the plugin's configuration, you can click the "Settings" button to make changes.
+After adding the plugin, you can see the newly added plugin in the plugin list. If you need to modify the plugin's configuration, you can click the <kbd>Settings</kbd> button to make changes.
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260093-a0363c74-0b5b-48dd-b103-2db6b4a8262e.png)
 
-### 3. Test the Plugin Functionality in a Session
+### **`3`** Test the Plugin Functionality in a Session
 
 Next, we need to test the functionality of the custom plugin.
 
-Click the "Back" button to go back to the session area, and then send a message to the assistant: "What should I wear?" The assistant will try to ask you about your gender and current mood.
+Click the <kbd>Back</kbd> button to go back to the session area, and then send a message to the assistant: "What should I wear?" The assistant will try to ask you about your gender and current mood.
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260291-f0aa0e7c-0ffb-486c-a834-08e73d49896f.png)
 
@@ -83,6 +89,8 @@ After answering, the assistant will make a plugin call to retrieve recommended c
 
 After completing these steps, you have learned the basic process of adding and using a custom plugin in LobeChat.
 
+<br/>
+
 ## Local Plugin Development
 
 In the previous workflow, we have learned how to add and use a plugin. Now let's focus on the development process of custom plugins.
@@ -190,7 +198,7 @@ In this example, `manClothes` and `womanClothes` are hardcoded mock data. In act
 
 #### Gateway
 
-Since the default plugin gateway in LobeChat is a cloud service (<https://chat.lobehub.com/api/plugins>), which sends requests to the API addresses specified in the manifest to solve the cross-origin issue.
+Since the default plugin gateway in LobeChat is a cloud service (\</api/plugins>), which sends requests to the API addresses specified in the manifest to solve the cross-origin issue.
 
 For custom plugins, the requests need to be sent to the local service. Therefore, by specifying the gateway in the manifest (<http://localhost:3400/api/gateway>), LobeChat will directly request this address. Then you only need to create a gateway implementation at this address.
 
@@ -248,15 +256,39 @@ const Render = memo(() => {
 export default Render;
 ```
 
+<br/>
+
 ## Plugin Deployment and Publication
 
 After completing the plugin development, you can deploy the plugin using your preferred method. For example, you can use Vercel or package it as a Docker image for publication.
 
 If you want more people to use your plugin, you are welcome to submit it for review in the plugin marketplace.
 
+[![][submit-plugin-shield]][submit-plugin-url]
+
+### Plugin Shield
+
+[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
+
+```markdown
+[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
+```
+
+<br/>
+
+## Link
+
+- **📘 Pluging SDK Docs**: <https://chat-plugin-sdk.lobehub.com>
+- **🚀 chat-plugin-template**: <https://github.com/lobehub/chat-plugin-template>
+- **🧩 chat-plugin-sdk**: <https://github.com/lobehub/chat-plugin-sdk>
+- **🚪 chat-plugin-sdk**: <https://github.com/lobehub/chat-plugin-gateway>
+- **🏪 lobe-chat-plugins**: <https://github.com/lobehub/lobe-chat-plugins>
+
 <!-- LINK GROUP -->
 
 [fetch-plugin-message-url]: https://github.com/lobehub/chat-plugin-template
 [lobe-chat-plugin-template-url]: https://github.com/lobehub/chat-plugin-template
-[manifest-docs-url]: https://github.com/lobehub/chat-plugin-sdk/tree/master/docs/manifest.zh-CN.md
+[manifest-docs-url]: https://chat-plugin-sdk.lobehub.com/guides/plugin-manifest
 [plugin-error-type-url]: https://github.com/lobehub/chat-plugin-template
+[submit-plugin-shield]: https://img.shields.io/badge/🧩/🏪_submit_plugin-%E2%86%92-50E3C2?style=for-the-badge
+[submit-plugin-url]: https://github.com/lobehub/lobe-chat-plugins

package/docs/Plugin-Development.zh-CN.md

@@ -6,9 +6,9 @@
 
 - [自定义插件流程](#自定义插件流程)
 
-  - [1. 创建并启动插件项目](#1-创建并启动插件项目)
-  - [2. 在 LobeChat 角色设置中添加本地插件](#2-在-lobechat-角色设置中添加本地插件)
-  - [3. 会话测试插件功能](#3-会话测试插件功能)
+  - [**`1`** 创建并启动插件项目](#1-创建并启动插件项目)
+  - [**`2`** 在 LobeChat 角色设置中添加本地插件](#2-在-lobechat-角色设置中添加本地插件)
+  - [**`3`** 会话测试插件功能](#3-会话测试插件功能)
 
 - [本地插件开发](#本地插件开发)
 
@@ -19,23 +19,29 @@
 
 - [插件部署与发布](#插件部署与发布)
 
+  - [插件 Shield](#插件-shield)
+
+- [链接](#链接)
+
 ## 插件构成
 
 一个 LobeChat 的插件由以下几个部分组成：
 
-1. **插件索引**：用于展示插件的基本信息，包括插件名称、描述、作者、版本、插件描述清单的链接，官方的插件索引地址：[lobe-chat-plugins](https://github.com/lobehub/lobe-chat-plugins)。若想上架插件到官方插件市场，需要[提交 PR](https://github.com/lobehub/lobe-chat-plugins/pulls) 到该仓库；
+1. **插件索引**：用于展示插件的基本信息，包括插件名称、描述、作者、版本、插件描述清单的链接，官方的插件索引地址：[lobe-chat-plugins](https://github.com/lobehub/lobe-chat-plugins)。若想上架插件到官方插件市场，需要 [提交 PR](https://github.com/lobehub/lobe-chat-plugins/pulls) 到该仓库；
 2. **插件描述清单 (manifest)**：用于描述插件的功能实现，包含了插件的服务端描述、前端展示信息、版本号等。关于 manifest 的详细介绍，详见 [manifest][manifest-docs-url]；
 3. **插件服务**：用于实现插件描述清单中所描述的服务端和前端模块，分别如下：
    - **服务端**：需要实现 manifest 中描述的 `api` 部分的接口能力；
-   - **前端 UI**（可选）：需要实现 manifest 中描述的 `ui` 部分的界面，该界面将会在插件消息中透出，进而实现比文本更加丰富地信息展示方式。
+   - **前端 UI**（可选）：需要实现 manifest 中描述的 `ui` 部分的界面，该界面将会在插件消息中透出，进而实现比文本更加丰富的信息展示方式。
+
+<br/>
 
 ## 自定义插件流程
 
-插件开发需要将插件集成进 LobeChat 中，因此本部分将会介绍如何在 LobeChat 中添加和使用一个自定义插件。
+本节将会介绍如何在 LobeChat 中添加和使用一个自定义插件。
 
-### 1. 创建并启动插件项目
+### **`1`** 创建并启动插件项目
 
-你需要先在本地创建一个插件项目，可以使用我们准备好的 [lobe-chat-plugin-template][lobe-chat-plugin-template-url] 模板；
+你需要先在本地创建一个插件项目，可以使用我们准备好的模板 [lobe-chat-plugin-template][lobe-chat-plugin-template-url]
 
 ```bash
 $ git clone https://github.com/lobehub/chat-plugin-template.git
@@ -44,35 +50,35 @@ $ npm i
 $ npm run dev
 ```
 
-当出现 `ready started server on 0.0.0.0:3400, url: http://localhost:3400` 时，说明插件服务已经在本地启动成功。
+当出现`ready started server on 0.0.0.0:3400, url: http://localhost:3400` 时，说明插件服务已经在本地启动成功。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259526-9ef25272-4312-429b-93bc-a95515727ed3.png)
 
-### 2. 在 LobeChat 角色设置中添加本地插件
+### **`2`** 在 LobeChat 角色设置中添加本地插件
 
 接下来进入到 LobeChat 中，创建一个新的助手，并进入它的会话设置页：
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259643-1a9cc34a-76f3-4ccf-928b-129654670efd.png)
 
-点击「插件列表」右侧的「添加」按钮，打开自定义插件添加弹窗：
+点击插件列表右侧的 <kbd>添加<kbd/> 按钮，打开自定义插件添加弹窗：
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259748-2ef6a244-39bb-483c-b359-f156ffcbe1a4.png)
 
-在 「插件描述文件 Url 地址」中填入 `http://localhost:3400/manifest-dev.json` ，这是我们本地启动的插件描述清单地址。
+在 **插件描述文件 Url** 地址 中填入 `http://localhost:3400/manifest-dev.json` ，这是我们本地启动的插件描述清单地址。
 
-此时，你应该可以看到看到插件的标识符一栏已经被自动识别为 `chat-plugin-template`。接下来你需要填写剩下的表单字段（只有标题必填），然后点击「保存」按钮，即可完成自定义插件添加。
+此时，你应该可以看到看到插件的标识符一栏已经被自动识别为 `chat-plugin-template`。接下来你需要填写剩下的表单字段（只有标题必填），然后点击 <kbd>保存</kbd> 按钮，即可完成自定义插件添加。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259964-59f4906d-ae2e-4ec0-8b43-db36871d0869.png)
 
-完成添加后，即可在插件列表中看到刚刚添加的插件，如果需要修改插件的配置，可以点击「设置」按钮进行修改。
+完成添加后，在插件列表中就能看到刚刚添加的插件，如果需要修改插件的配置，可以点击最右侧的 <kbd>设置</kbd> 按钮进行修改。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260093-a0363c74-0b5b-48dd-b103-2db6b4a8262e.png)
 
-### 3. 会话测试插件功能
+### **`3`** 会话测试插件功能
 
-接来下我们需要测试下这个自定义插件的功能是否正常。
+接来下我们需要测试这个插件的功能是否正常。
 
-点击「返回」按钮回到会话区，然后向助手发送消息：「我应该穿什么？ 」此时助手将会尝试向你询问，了解你的性别与当前的心情。
+点击 <kbd>返回</kbd> 按钮回到会话区，然后向助手发送消息：「我应该穿什么？ 」此时助手将会尝试向你询问，了解你的性别与当前的心情。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260291-f0aa0e7c-0ffb-486c-a834-08e73d49896f.png)
 
@@ -82,15 +88,17 @@ $ npm run dev
 
 当完成这些操作后，你已经了解了添加自定义插件，并在 LobeChat 中使用的基础流程。
 
+<br/>
+
 ## 本地插件开发
 
 在上述流程中，我们已经了解插件的添加和使用的方式，接下来重点介绍自定义插件开发的过程。
 
 ### manifest
 
-manifest 聚合了插件功能如何实现的信息。核心的字段为 `api` 与 `ui`，分别描述了插件的服务端接口能力与前端渲染的界面地址。
+`manifest` 聚合了插件功能如何实现的信息。核心字段为 `api` 与 `ui`，分别描述了插件的服务端接口能力与前端渲染的界面地址。
 
-以我们提供的模板中的 manifest 为例：
+以我们提供的模板中的 `manifest` 为例：
 
 ```json
 {
@@ -130,12 +138,12 @@ manifest 聚合了插件功能如何实现的信息。核心的字段为 `api`
 在这份 manifest 中，主要包含了以下几个部分：
 
 1. `identifier`：这是插件的唯一标识符，用来区分不同的插件，这个字段需要全局唯一。
-2. `api`：这是一个数组，包含了插件所提供的所有 API 接口信息。每个接口都包含了url、name、description和 parameters 字段，均为必填项。其中 `description` 和 `parameters` 两个字段，将会作为 [Function Call](https://sspai.com/post/81986) 的 `functions` 参数发送给 gpt， parameters 需要符合 [JSON Schema](https://json-schema.org/) 规范。 在这个例子中，api 接口名为 `recommendClothes` ，这个接口的功能是根据用户的心情和性别来推荐衣服。接口的参数包括用户的心情和性别，这两个参数都是必填项。
+2. `api`：这是一个数组，包含了插件的所有 API 接口信息。每个接口都包含了url、name、description 和 parameters 字段，均为必填项。其中 `description` 和 `parameters` 两个字段，将会作为 [Function Call](https://sspai.com/post/81986) 的 `functions` 参数发送给 gpt， parameters 需要符合 [JSON Schema](https://json-schema.org/) 规范。 在这个例子中，api 接口名为 `recommendClothes` ，这个接口的功能是根据用户的心情和性别来推荐衣服。接口的参数包括用户的心情和性别，这两个参数都是必填项。
 3. `ui`：这个字段包含了插件的用户界面信息，指明了 LobeChat 从哪个地址加载插件的前端界面。由于 LobeChat 插件界面加载是基于 iframe 实现的，因此可以按需指定插件界面的高度、宽度。
-4. `gateway`：这个字段指定了 LobeChat 查询 api 接口的网关。LobeChat 默认的插件网关是云端服务，而自定义插件的请求需要发送给本地服务的，因此通过在 manifest 中指定网关，LobeChat 将会直接请求这个地址，进而访问到本地的插件服务，发布到线上的插件可以不用指定该字段。
+4. `gateway`：这个字段指定了 LobeChat 查询 api 接口的网关。LobeChat 默认的插件网关是云端服务，而自定义插件的请求需要发给本地启动的服务，远端调用本地地址，一般调用不通。gateway 字段解决了该问题。通过在 manifest 中指定 gateway，LobeChat 将会向该地址发送插件请求，本地的网关地址将会调度请求到本地的插件服务。发布到线上的插件可以不用指定该字段。
 5. `version`：这是插件的版本号，现阶段暂时没有作用；
 
-在实际开发中，你可以根据自己的需求，修改插件的描述清单，声明自己想要实现的功能。 关于 manifest 各个字段的完整介绍，参见：[manifest][manifest-docs-url]。
+在实际开发中，你可以根据自己的需求，修改插件的描述清单，声明想要实现的功能。 关于 manifest 各个字段的完整介绍，参见：[manifest][manifest-docs-url]。
 
 ### 项目结构
 
@@ -153,15 +161,15 @@ manifest 聚合了插件功能如何实现的信息。核心的字段为 `api`
 │   │   └── index.tsx                # 前端展示界面
 ```
 
-当然，模板使用 Next.js 作为开发框架，只是因为我们熟悉 Next.js，开发方便。你可以使用任何你熟悉的开发框架与开发语言，只要能够实现 manifest 中描述的功能即可。
+本模板使用 Next.js 作为开发框架。你可以使用任何你熟悉的开发框架与开发语言，只要能够实现 manifest 中描述的功能即可。
 
-同时也欢迎贡献更多框架与语言的插件模板。
+同时也欢迎大家贡献更多框架与语言的插件模板。
 
 ### 服务端
 
-服务端只需要实现 manifest 中描述的 api 接口即可。在模板中，我们使用了 vercel 的 [Edge Runtime](https://nextjs.org/docs/pages/api-reference/edge) 作为服务，免去运维成本。
+服务端需要实现 manifest 中描述的 api 接口。在模板中，我们使用了 vercel 的 [Edge Runtime](https://nextjs.org/docs/pages/api-reference/edge)，免去运维。
 
-#### api 实现
+#### API 实现
 
 针对 Edge Runtime ，我们在 `@lobehub/chat-plugin-sdk` 提供了 `createErrorResponse` 方法，用于快速返回错误响应。目前提供的错误类型详见：[PluginErrorType][plugin-error-type-url]。
 
@@ -185,13 +193,13 @@ export default async (req: Request) => {
 };
 ```
 
-其中 `maniClothes` 和 `womanClothes` 是写死的 mock 数据，在实际场景中，可以替换为数据库请求。
+其中 `maniClothes` 和 `womanClothes` 是 mock 数据，在实际场景中，可以替换为数据库查询等。
 
-#### gateway
+#### Plugin Gateway
 
-由于 LobeChat 默认的插件网关是云端服务（<https://chat.lobehub.com/api/plugins>），云端服务通过 manifest 上的 api 地址发送请求，以解决跨域问题。
+由于 LobeChat 默认的插件网关是云端服务 `/api/plugins`，云端服务通过 manifest 上的 `api.url` 地址发送请求，以解决跨域问题。
 
-而针对自定义插件，插件的请求需要发送给本地服务的， 因此通过在 manifest 中指定网关 (<http://localhost:3400/api/gateway>)，LobeChat 将会直接请求该地址，然后只需要在该地址下创建一个网关实现即可。
+针对自定义插件，插件请求需要发送给本地服务， 因此通过在 manifest 中指定网关 (<http://localhost:3400/api/gateway>)，LobeChat 将会直接请求该地址，然后只需要在该地址下创建对应的网关即可。
 
 ```ts
 import { createLobeChatPluginGateway } from '@lobehub/chat-plugins-gateway';
@@ -207,21 +215,21 @@ export default async createLobeChatPluginGateway();
 
 ### 插件 UI 界面
 
-对于一个插件而言，UI 界面是一个可选项。例如 [「网页内容提取」插件](https://github.com/lobehub/chat-plugin-web-crawler)，就没有实现相应的用户界面。
+自定义插件的 UI 界面是一个可选项。例如 官方插件 [「🧩 / 🕸 网页内容提取」](https://github.com/lobehub/chat-plugin-web-crawler)，没有实现相应的用户界面。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265263241-0e765fdc-3463-4c36-a398-aef177a30df9.png)
 
-如果你希望在插件消息中展示更加丰富的信息，或者包含一些富交互，可以为插件定义一个用户界面。例如下图，则为搜索引擎插件的用户界面。
+如果你希望在插件消息中展示更加丰富的信息，或者包含一些富交互操作，你可以为插件定制一个用户界面。例如下图则为[「搜索引擎」](https://github.com/lobehub/chat-plugin-search-engine)插件的用户界面。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265263427-9bdc03d5-aa61-4f62-a2ce-88683f3308d8.png)
 
 #### 插件 UI 界面实现
 
-LobeChat 通过 `iframe` + `postMessage` 实现插件 ui 的加载与通信。因此， 插件 UI 的实现方式与普通的网页开发一致，你可以使用任何你熟悉的前端框架与开发语言。
+LobeChat 通过 `iframe` 实现插件 ui 的加载,使用 `postMessage` 实现主体与插件的通信。因此， 插件 UI 的实现方式与普通的网页开发一致，你可以使用任何你熟悉的前端框架与开发语言。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265263653-4ea87abc-249a-49f3-a241-7ed93ddb1ddf.png)
 
-在我们提供的模板中，我们使用了 React + Next.js + antd 作为前端界面框架，你可以在 `src/pages/index.tsx` 中找到用户界面的实现。
+在我们提供的模板中使用了 React + Next.js + [antd](https://ant.design/) 作为前端界面框架，你可以在 [`src/pages/index.tsx`](https://github.com/lobehub/chat-plugin-template/blob/main/src/pages/index.tsx) 中找到用户界面的实现。
 
 其中关于插件通信，我们在 [`@lobehub/chat-plugin-sdk`](https://github.com/lobehub/chat-plugin-sdk) 提供了相关方法，用于简化插件与 LobeChat 的通信。你可以通过 `fetchPluginMessage` 方法主动向 LobeChat 获取当前消息的数据。关于该方法的详细介绍，参见：[fetchPluginMessage][fetch-plugin-message-url]。
 
@@ -247,15 +255,39 @@ const Render = memo(() => {
 export default Render;
 ```
 
+<br/>
+
 ## 插件部署与发布
 
 当你完成插件的开发后，你可以使用你习惯的方式进行插件的部署。例如使用 vercel ，或者打包成 docker 发布等等。
 
 如果你希望插件被更多人使用，欢迎将你的插件 [提交上架](https://github.com/lobehub/lobe-chat-plugins) 到插件市场。
 
+[![][submit-plugin-shield]][submit-plugin-url]
+
+### 插件 Shield
+
+[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
+
+```markdown
+[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
+```
+
+<br/>
+
+## 链接
+
+- **📘 Pluging SDK 文档**: <https://chat-plugin-sdk.lobehub.com>
+- **🚀 chat-plugin-template**: <https://github.com/lobehub/chat-plugin-template>
+- **🧩 chat-plugin-sdk**: <https://github.com/lobehub/chat-plugin-sdk>
+- **🚪 chat-plugin-gateway**: <https://github.com/lobehub/chat-plugin-gateway>
+- **🏪 lobe-chat-plugins**: <https://github.com/lobehub/lobe-chat-plugins>
+
 <!-- LINK GROUP -->
 
 [fetch-plugin-message-url]: https://github.com/lobehub/chat-plugin-template
 [lobe-chat-plugin-template-url]: https://github.com/lobehub/chat-plugin-template
-[manifest-docs-url]: https://github.com/lobehub/chat-plugin-sdk/tree/master/docs/manifest.zh-CN.md
+[manifest-docs-url]: https://chat-plugin-sdk.lobehub.com/guides/plugin-manifest
 [plugin-error-type-url]: https://github.com/lobehub/chat-plugin-template
+[submit-plugin-shield]: https://img.shields.io/badge/🧩/🏪_submit_plugin-%E2%86%92-50E3C2?style=for-the-badge
+[submit-plugin-url]: https://github.com/lobehub/lobe-chat-plugins

package/docs/{Upstream-Sync.en-US.md → Upstream-Sync.md}

@@ -8,9 +8,10 @@ If you have deployed your own project following the one-click deployment steps i
 
 ## Enabling Automatic Updates
 
-> **👉🏻 Note：** If you encounter an error executing Upstream Sync, manually Sync Fork once
+> **Note**\
+> If you encounter an error executing Upstream Sync, manually Sync Fork once
 
 Once you have forked the project, due to Github restrictions, you will need to manually enable Workflows on the Actions page of your forked project and activate the Upstream Sync Action. Once enabled, you can set up hourly automatic updates.
 
-![sync-1](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png)
-![sync-2](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png)
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)

package/docs/Upstream-Sync.zh-CN.md

@@ -8,9 +8,10 @@
 
 ## 启动自动更新
 
-> **👉🏻 提示：** 如果你在执行 `Upstream Sync` 时遇到错误，请手动执再行一次
+> **Note**\
+> 如果你在执行 `Upstream Sync` 时遇到错误，请手动执再行一次
 
 当你 Fork 了项目后，由于 Github 的限制，你需要手动在你 Fork 的项目的 Actions 页面启用 Workflows，并启动 Upstream Sync Action。启用后，你可以设置每小时进行一次自动更新。
 
-![sync-1](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png)
-![sync-2](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png)
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)

package/docs/_Sidebar.md

@@ -1,22 +1,29 @@
 ## Lobe Chat Wiki
 
-### 🏠 Home
+#### 🏠 Home
 
-- [TOC](Home)
+- [TOC](Home) | [目录](Home)
 
-### 🤯 LobeChat
+#### 🤯 LobeChat
 
-- [Upstream Sync](Upstream-Sync.en-US)
-  - [English](Upstream-Sync.en-US)
-  - [简体中文](Upstream-Sync.zh-CN)
+- [Upstream Sync](Upstream-Sync) | [中文](Upstream-Sync.zh-CN)
+- [Deploying with Azure OpenAI](Deploy-with-Azure-OpenAI) | [中文](Deploy-with-Azure-OpenAI.zh-CN)
 
-### 🤖 Agents
+#### 🤖 Agents
 
-- [Agent Index](https://github.com/lobehub/lobe-chat-agents)
+- [Agent Index][agent-index] | [中文][agent-index-cn]
 
-### 🧩 Plugins
+#### 🧩 Plugins
 
-- [Plugin Index](https://github.com/lobehub/lobe-chat-plugins)
-- [Plugin Development](Plugin-Development.en-US)
-  - [English](Plugin-Development.en-US)
-  - [简体中文](Plugin-Development.zh-CN)
+- [Plugin Index][plugin-index] | [中文][plugin-index-cn]
+- [Plugin Development](Plugin-Development) | [中文](Plugin-Development.zh-CN)
+- [Plugin SDK Docs][plugin-sdk] | [中文][plugin-skd-cn]
+
+<!-- LINK GROUP -->
+
+[agent-index]: https://github.com/lobehub/lobe-chat-agents
+[agent-index-cn]: https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md
+[plugin-index]: https://github.com/lobehub/lobe-chat-plugins
+[plugin-index-cn]: https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md
+[plugin-sdk]: https://chat-plugin-sdk.lobehub.com
+[plugin-skd-cn]: https://chat-plugin-sdk.lobehub.com

package/locales/en_US/common.json

@@ -1,49 +1,49 @@
 {
   "about": "About",
   "advanceSettings": "Advanced Settings",
-  "agentDefaultMessage": "Hello, I'm **{{name}}**. You can start chatting with me right away or go to [Assistant Settings](/chat/setting#session={{id}}) to complete my information.",
+  "agentDefaultMessage": "Hello, I'm **{{name}}**. You can start chatting with me right away or go to [Agent Settings](/chat/setting#session={{id}}) to complete my information.",
   "agentDefaultMessageWithSystemRole": "Hello, I'm **{{name}}**, {{systemRole}}. Let's start chatting!",
   "agentMaxToken": "Max Session Length",
   "agentModel": "Model",
-  "agentProfile": "Assistant Information",
+  "agentProfile": "Agent Information",
   "appInitializing": "LobeChat is initializing, please wait...",
   "archive": "Archive",
   "autoGenerate": "Auto Generate",
-  "autoGenerateTooltip": "Auto generate assistant description based on prompts",
+  "autoGenerateTooltip": "Auto generate agent description based on prompts",
   "backToBottom": "Go to Latest Messages",
   "cancel": "Cancel",
   "changelog": "Changelog",
   "clearCurrentMessages": "Clear Current Session Messages",
   "close": "Close",
   "confirmClearCurrentMessages": "You are about to clear the current session messages. Once cleared, they cannot be recovered. Please confirm your operation.",
-  "confirmRemoveSessionItemAlert": "You are about to delete this assistant. Once deleted, it cannot be recovered. Please confirm your operation.",
+  "confirmRemoveSessionItemAlert": "You are about to delete this agent. Once deleted, it cannot be recovered. Please confirm your operation.",
   "copy": "Copy",
   "copySuccess": "Copy Success",
-  "defaultAgent": "Custom Assistant",
-  "defaultSession": "Custom Assistant",
+  "defaultAgent": "Custom Agent",
+  "defaultSession": "Custom Agent",
   "delete": "Delete",
   "edit": "Edit",
   "export": "Export Configuration",
   "exportType": {
-    "agent": "Export Assistant Settings",
-    "agentWithMessage": "Export Assistant and Messages",
-    "all": "Export Global Settings and All Assistant Data",
-    "allAgent": "Export All Assistant Settings",
-    "allAgentWithMessage": "Export All Assistants and Messages",
+    "agent": "Export Agent Settings",
+    "agentWithMessage": "Export Agent and Messages",
+    "all": "Export Global Settings and All Agent Data",
+    "allAgent": "Export All Agent Settings",
+    "allAgentWithMessage": "Export All Agents and Messages",
     "globalSetting": "Export Global Settings"
   },
   "feedback": "Feedback",
   "import": "Import Configuration",
   "inbox": {
-    "defaultMessage": "Hello, I'm your intelligent assistant. You can ask me any questions and I will do my best to answer you. If you need a more professional or customized assistant, you can click <kbd>+</kbd> to create a custom assistant.",
-    "desc": "Activate the brain cluster and spark your thinking. Your intelligent assistant is here to communicate with you about everything.",
+    "defaultMessage": "Hello, I'm your intelligent agent. You can ask me any questions and I will do my best to answer you. If you need a more professional or customized agent, you can click <kbd>+</kbd> to create a custom agent.",
+    "desc": "Activate the brain cluster and spark your thinking. Your intelligent agent is here to communicate with you about everything.",
     "title": "Chat Freely"
   },
   "message": {
     "function_loading": "Plugin request in progress..."
   },
   "moreSetting": "More Settings...",
-  "newAgent": "New Assistant",
+  "newAgent": "New Agent",
   "noDescription": "No Description",
   "ok": "OK",
   "pin": "Pin",
@@ -53,10 +53,10 @@
   "reset": "Reset",
   "retry": "Retry",
   "roleAndArchive": "Roles and Archives",
-  "searchAgentPlaceholder": "Search Assistants and Conversations...",
+  "searchAgentPlaceholder": "Search Agents and Conversations...",
   "send": "Send",
   "sendPlaceholder": "Enter chat content...",
-  "sessionList": "Assistant List",
+  "sessionList": "Agent List",
   "setting": "Settings",
   "share": "Share",
   "stop": "Stop",
@@ -79,7 +79,7 @@
     "searchPlaceholder": "Search Topics...",
     "title": "Topic"
   },
-  "updateAgent": "Update Assistant Information",
+  "updateAgent": "Update Agent Information",
   "updatePrompt": "Update Prompts",
   "warp": "Line break"
 }

package/locales/en_US/market.json

@@ -1,12 +1,16 @@
 {
-  "addAgent": "Add Assistant",
+  "addAgent": "Add Agent",
   "search": {
-    "placeholder": "Search assistant name, description or keywords..."
+    "placeholder": "Search agent name, description or keywords..."
   },
   "sidebar": {
     "comment": "Comments",
     "prompt": "Prompts",
-    "title": "Assistant Details"
+    "title": "Agent Details"
   },
-  "submitAgent": "Submit Assistant"
-}
+  "submitAgent": "Submit Agent",
+  "title": {
+    "recentSubmits": "Recent Submits",
+    "allAgents": "All Agents"
+  }
+}

package/locales/en_US/setting.json

@@ -73,7 +73,8 @@
       "useAzure": {
         "desc": "Using OpenAI services from Azure",
         "fetch": "Get list",
-        "title": "Azure OpenAI"
+        "title": "Azure OpenAI",
+        "serverConfig": "The administrator has enabled Azure OpenAI on the server side, switching is prohibited"
       }
     },
     "waitingForMore": "<1>Access to other models is planned</1>, so stay tuned ✨"
@@ -86,11 +87,11 @@
       "title": "Background Color"
     },
     "description": {
-      "placeholder": "Please enter assistant description",
-      "title": "Assistant Description"
+      "placeholder": "Please enter agent description",
+      "title": "Agent Description"
     },
     "name": {
-      "placeholder": "Please enter assistant name",
+      "placeholder": "Please enter agent name",
       "title": "Name"
     },
     "prompt": {
@@ -101,7 +102,7 @@
       "placeholder": "Please enter tag",
       "title": "Tag"
     },
-    "title": "Assistant Information"
+    "title": "Agent Information"
   },
   "settingChat": {
     "chatStyleType": {
@@ -229,8 +230,8 @@
     "title": "Theme Settings"
   },
   "tab": {
-    "agent": "Default Assistant",
+    "agent": "Default Agent",
     "common": "Common Settings",
     "llm": "Custom LLM API"
   }
-}
+}

package/locales/en_US/welcome.json

@@ -4,11 +4,11 @@
     "start": "Start Now"
   },
   "header": "Welcome",
-  "pickAgent": "Or choose from the following assistant templates",
+  "pickAgent": "Or choose from the following agent templates",
   "skip": "Skip Creation",
   "slogan": {
-    "desc1": "Unlock the power of your brain and ignite your creativity. Your intelligent assistant is always here.",
-    "desc2": "Create your first assistant and let's get started~",
+    "desc1": "Unlock the power of your brain and ignite your creativity. Your intelligent agent is always here.",
+    "desc2": "Create your first agent and let's get started~",
     "title": "Give yourself a smarter brain"
   }
 }

package/locales/ru_RU/market.json

@@ -8,5 +8,9 @@
     "prompt": "Подсказка",
     "title": "Детали агента"
   },
-  "submitAgent": "Отправить агента"
-}
+  "submitAgent": "Отправить агента",
+  "title": {
+    "recentSubmits": "Недавние добавления",
+    "allAgents": "Все агенты"
+  }
+}