diff --git a/docs/en/dev/star/guides/plugin-config.md b/docs/en/dev/star/guides/plugin-config.md index 169712b63..1e0247214 100644 --- a/docs/en/dev/star/guides/plugin-config.md +++ b/docs/en/dev/star/guides/plugin-config.md @@ -15,7 +15,7 @@ The file content is a `Schema` that represents the configuration. The Schema is { "token": { "description": "Bot Token", - "type": "string", + "type": "string" }, "sub_config": { "description": "Test nested configuration", diff --git a/docs/en/providers/start.md b/docs/en/providers/start.md index 3cc5fe9f3..936626961 100644 --- a/docs/en/providers/start.md +++ b/docs/en/providers/start.md @@ -38,4 +38,4 @@ Using DeepSeek as an example, assuming you have registered and logged in to a De > Introduced in v4.13.0. -You can use environment variables to load provider API keys. In the provider configuration page, set the API Key field to `$ENV_VARIABLE_NAME`, for example: `$DEESEEK_API_KEY`. +You can use environment variables to load provider API keys. In the provider configuration page, set the API Key field to `$ENV_VARIABLE_NAME`, for example: `$DEEPSEEK_API_KEY`. diff --git a/docs/en/use/websearch.md b/docs/en/use/websearch.md index 119166d38..072983ad0 100644 --- a/docs/en/use/websearch.md +++ b/docs/en/use/websearch.md @@ -3,7 +3,7 @@ The web search feature gives large language models internet retrieval capability for recent information, which can improve response accuracy and reduce hallucinations to some extent. -AstrBot's built-in web search functionality relies on the large language model's `function calling` capability. If you're not familiar with function calling, please refer to: [Function Calling](/use/websearch). +AstrBot's built-in web search functionality relies on the large language model's `function calling` capability. If you're not familiar with function calling, please refer to: [Function Calling](/en/use/function-calling.html). When using a large language model that supports function calling with the web search feature enabled, you can try saying: diff --git a/docs/zh/dev/star/guides/plugin-config.md b/docs/zh/dev/star/guides/plugin-config.md index 13138eae9..8374cdcd1 100644 --- a/docs/zh/dev/star/guides/plugin-config.md +++ b/docs/zh/dev/star/guides/plugin-config.md @@ -15,7 +15,7 @@ AstrBot 提供了“强大”的配置解析和可视化功能。能够让用户 { "token": { "description": "Bot Token", - "type": "string", + "type": "string" }, "sub_config": { "description": "测试嵌套配置", diff --git a/docs/zh/dev/star/plugin-publish.md b/docs/zh/dev/star/plugin-publish.md index 14b452056..45997acc5 100644 --- a/docs/zh/dev/star/plugin-publish.md +++ b/docs/zh/dev/star/plugin-publish.md @@ -4,6 +4,6 @@ AstrBot 使用 GitHub 托管插件，因此你需要先将插件代码推送到之前创建的 GitHub 插件仓库中。 -你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后，点击右下角的 `+` 按钮，填写好基本信息、作者信息、仓库信息等内容后，点击 `提交到 GTIHUB` 按钮，你将会被导航到 AstrBot 仓库的 Issue 提交页面，请确认信息无误后点击 `Create` 按钮提交，即可完成插件发布。 +你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后，点击右下角的 `+` 按钮，填写好基本信息、作者信息、仓库信息等内容后，点击 `提交到 GITHUB` 按钮，你将会被导航到 AstrBot 仓库的 Issue 提交页面，请确认信息无误后点击 `Create` 按钮提交，即可完成插件发布。 ![fill out the form](https://files.astrbot.app/docs/source/images/plugin-publish/image.png) diff --git a/docs/zh/platform/discord.md b/docs/zh/platform/discord.md index 8e50fc205..c5aaaaeb6 100644 --- a/docs/zh/platform/discord.md +++ b/docs/zh/platform/discord.md @@ -24,7 +24,7 @@ 2. 点击左边栏的 Bot，点击 Reset Token 按钮，创建好 Token 后，点击 Copy 按钮，将 Token 填入配置中的 Discord Bot Token 处。 ![token选项](https://files.astrbot.app/docs/source/images/discord/image-4.png) -4. 下滑找到这三个选项全开启 +3. 下滑找到这三个选项全开启 ![Presence Intent,Server Members Intent,Message Content Intent截图](https://files.astrbot.app/docs/source/images/discord/image-2.png) @@ -32,7 +32,7 @@ - Server Members Intent：允许机器人获取服务器成员信息 - Message Content Intent：允许机器人读取消息内容 -5. 点击左边栏的 OAuth2，在 OAuth2 URL Generator 中选中 `Bot` +4. 点击左边栏的 OAuth2，在 OAuth2 URL Generator 中选中 `Bot` 也就是这样 ![OAuth2 URL Generator](https://files.astrbot.app/docs/source/images/discord/image-6.png) 然后在下方出现的 Bot Permissions 处选择允许的权限。一般来说，建议添加如下权限： @@ -49,10 +49,10 @@ 如果你觉得麻烦也可以直接使用administrator权限，但仍然建议在使用环境中使用上文的配置权限（或您自己需要的权限） > 记住，权限越高，风险越大。 -6. 复制下方出现的 Generated URL。打开这个 URL，将 Bot 添加到所需要的服务器。 +5. 复制下方出现的 Generated URL。打开这个 URL，将 Bot 添加到所需要的服务器。 ![Generated URL位置](https://files.astrbot.app/docs/source/images/discord/image-5.png) -7. 进入 Discord 服务器，你的机器人应该已经提示在线了 +6. 进入 Discord 服务器，你的机器人应该已经提示在线了 ![机器人在线](https://files.astrbot.app/docs/source/images/discord/image-7.png) @ 刚刚创建的机器人（也可以不 @），输入 `/help`，如果成功返回，则测试成功。 diff --git a/docs/zh/platform/lark.md b/docs/zh/platform/lark.md index 206e65406..c5525b254 100644 --- a/docs/zh/platform/lark.md +++ b/docs/zh/platform/lark.md @@ -68,7 +68,7 @@ ### `webhook` 将事件发送至开发者服务器方式 > [!TIP] -> 为了更好地使用这种方式，请先参考 [统一 Webhook 模式](/zh/use/unified-webhook.md#如何使用统一-webhook-模式) 做好相关配置。 +> 为了更好地使用这种方式，请先参考 [统一 Webhook 模式](/use/unified-webhook.html) 做好相关配置。 在点击 `保存` 后，机器人卡片会显示「查看 Webhook 链接」，点击查看，复制回调 URL。 diff --git a/docs/zh/platform/wecom.md b/docs/zh/platform/wecom.md index 0774a05fe..02efe52c4 100644 --- a/docs/zh/platform/wecom.md +++ b/docs/zh/platform/wecom.md @@ -119,7 +119,7 @@ AstrBot 支持接入企业微信应用和微信客服。 将你的 公网 IP 地址填写到此处，点击确定。 -重启成功后，回到API 接收页面，点击下面的保存，看是否能\够保存成功。如果出现 `openapi 请求回调地址不通过` 说明配置有问题，请检查四个配置项是否填写正确。 +重启成功后，回到API 接收页面，点击下面的保存，看是否能够保存成功。如果出现 `openapi 请求回调地址不通过` 说明配置有问题，请检查四个配置项是否填写正确。 如果能够保存成功，AstrBot 就已经能够接收信息。 diff --git a/docs/zh/providers/start.md b/docs/zh/providers/start.md index e1241462e..d1cea9181 100644 --- a/docs/zh/providers/start.md +++ b/docs/zh/providers/start.md @@ -38,4 +38,4 @@ AstrBot 适配了 OpenAI、Google GenAI、Anthropic 三种原生 API 格式。 > v4.13.0 之后引入 -支持使用环境变量加载模型服务提供商的 API Key。在提供商配置页面，将 API Key 一栏填写为 `$环境变量名称` 的名称即可，例如填写 `$DEESEEK_API_KEY`。 \ No newline at end of file +支持使用环境变量加载模型服务提供商的 API Key。在提供商配置页面，将 API Key 一栏填写为 `$环境变量名称` 的名称即可，例如填写 `$DEEPSEEK_API_KEY`。 diff --git a/docs/zh/use/knowledge-base.md b/docs/zh/use/knowledge-base.md index 43a564956..5f4088e51 100644 --- a/docs/zh/use/knowledge-base.md +++ b/docs/zh/use/knowledge-base.md @@ -3,7 +3,7 @@ > [!TIP] > 需要 AstrBot 版本 >= 4.5.0。 > -> 我们在 4.5.0 版本中重新设计了全新的知识库系统，AstrBot 将原生支持知识库功能。下文介绍的是新版知识库的使用方法。如果您使用的是之前的版本，请参考[旧版知识库使用文档](https://docs.astrbot.app/zh/use/knowledge-base-old), 我们建议您升级到最新版以获得更好的体验。 +> 我们在 4.5.0 版本中重新设计了全新的知识库系统，AstrBot 将原生支持知识库功能。下文介绍的是新版知识库的使用方法。如果您使用的是之前的版本，请参考[旧版知识库使用文档](/use/knowledge-base-old.html)，我们建议您升级到最新版以获得更好的体验。 ![知识库预览](https://files.astrbot.app/docs/zh/use/image-3.png) @@ -46,7 +46,7 @@ AstrBot 支持多知识库管理。在聊天时，您可以**自由指定知识 在配置文件中，可以为不同的配置文件指定不同的知识库。 -## 附录 2：高性价比的嵌入模型申请 +## 附录：高性价比的嵌入模型申请 ### 硅基流动 diff --git a/docs/zh/use/unified-webhook.md b/docs/zh/use/unified-webhook.md index cbfdd30a9..25e22d06e 100644 --- a/docs/zh/use/unified-webhook.md +++ b/docs/zh/use/unified-webhook.md @@ -17,7 +17,7 @@ 1. 拥有一个域名（如 example.com）和公网 IP 服务器 2. 配置 DNS 解析（如 astrbot.example.com） 3. 配置反向代理，将域名的 80 或 443 端口请求转发到 AstrBot 的 WebUI 端口（默认为 6185） -4. 前往 AstrBot `配置文件` 页，点击 `系统`，将 `对外可达的回调接口地址` 为配置的 URL 地址。（如 https://astrbot.example.com），点击保存，等待重启。 +4. 前往 AstrBot `配置文件` 页，点击 `系统`，将 `对外可达的回调接口地址` 填写为配置的 URL 地址。（如 https://astrbot.example.com），点击保存，等待重启。 在之后配置各个平台适配器时，选择开启 `统一 Webhook 模式 (unified_webhook_mode)`。 diff --git a/docs/zh/use/websearch.md b/docs/zh/use/websearch.md index 9173d40ad..dddd0f56f 100644 --- a/docs/zh/use/websearch.md +++ b/docs/zh/use/websearch.md @@ -2,7 +2,7 @@ 网页搜索功能旨在为大模型提供联网检索能力，以获取最近信息，一定程度上能够提高回复准确度，减少幻觉。 -AstrBot 内置的网页搜索功能依赖大模型提供 `函数调用` 能力。如果你不了解函数调用，请参考：[函数调用](/use/websearch)。 +AstrBot 内置的网页搜索功能依赖大模型提供 `函数调用` 能力。如果你不了解函数调用，请参考：[函数调用](/use/function-calling.html)。 在使用支持函数调用的大模型且开启了网页搜索功能的情况下，您可以试着说：