mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-16 01:40:15 +08:00
docs: 文档更新 - 指令、FAQ、网页搜索、插件发布等 (#8912)
* docs(community): 更新 QQ 群组信息 - 移除了旧的 QQ 群组信息并添加了新的群组。 - 确保所有群组信息的准确性和完整性。 - 提升文档的可读性和用户体验。 * docs(webui): 为忘记密码章节添加 FAQ 引用链接 - 在英文和中文文档的"忘记密码"章节末尾添加 TIP 提示框 - 提示框链接至对应 FAQ 条目,提供更详细的操作说明 - 增强文档之间的关联性,提升用户查阅体验 * docs(command): 新增 /stats 和 /provider 指令文档,更新 FAQ 管理员指令列表 - 在英文和中文的命令文档中添加 /stats 和 /provider 指令的详细使用说明 - 更新中英文 FAQ 页面的管理员指令列表,与最新的默认指令保持一致 - 确保中英文文档内容同步,提升文档准确性和用户查阅体验 * docs(websearch): 新增 Firecrawl 网页搜索提供商文档支持 - 在开发版配置文档中补充 websearch_provider 选项,加入 firecrawl 及对应密钥配置项 - 更新中英文网页搜索使用指南,将支持搜索源数量同步为五种并提供 Firecrawl 注册指引 - 确保中英文文档内容一致,提升配置说明的完整性和用户查阅体验 * docs(plugin-publish): 更新插件提交方式至新仓库 - 废弃通过 AstrBot 主仓库 Issue 提交插件的方式 - 新增警告框提示正确提交入口为 AstrBot_Plugins_Collection - 同步更新中英文版插件发布文档
This commit is contained in:
10
README.md
10
README.md
@@ -234,10 +234,6 @@ pre-commit install
|
|||||||
|
|
||||||
### QQ Groups
|
### QQ Groups
|
||||||
|
|
||||||
- Group 12: 916228568 (New)
|
|
||||||
- Group 9: 1076659624 (Full)
|
|
||||||
- Group 10: 1078079676 (Full)
|
|
||||||
- Group 11: 704659519 (Full)
|
|
||||||
- Group 1: 322154837 (Full)
|
- Group 1: 322154837 (Full)
|
||||||
- Group 3: 630166526 (Full)
|
- Group 3: 630166526 (Full)
|
||||||
- Group 4: 1077826412 (Full)
|
- Group 4: 1077826412 (Full)
|
||||||
@@ -245,6 +241,12 @@ pre-commit install
|
|||||||
- Group 6: 753075035 (Full)
|
- Group 6: 753075035 (Full)
|
||||||
- Group 7: 743746109 (Full)
|
- Group 7: 743746109 (Full)
|
||||||
- Group 8: 1030353265 (Full)
|
- Group 8: 1030353265 (Full)
|
||||||
|
- Group 9: 1076659624 (Full)
|
||||||
|
- Group 10: 1078079676 (Full)
|
||||||
|
- Group 11: 704659519 (Full)
|
||||||
|
- Group 12: 916228568 (Full)
|
||||||
|
- Group 13: 1092185289
|
||||||
|
- Group 14: 1103419483
|
||||||
|
|
||||||
- Developer Group(Chit-chat): 975206796
|
- Developer Group(Chit-chat): 975206796
|
||||||
- Developer Group(Formal): 1039761811
|
- Developer Group(Formal): 1039761811
|
||||||
|
|||||||
12
README_zh.md
12
README_zh.md
@@ -226,10 +226,6 @@ pre-commit install
|
|||||||
|
|
||||||
### QQ 群组
|
### QQ 群组
|
||||||
|
|
||||||
- 12 群:916228568 (新)
|
|
||||||
- 9 群:1076659624 (人满)
|
|
||||||
- 10 群:1078079676 (人满)
|
|
||||||
- 11 群:704659519 (人满)
|
|
||||||
- 1 群:322154837 (人满)
|
- 1 群:322154837 (人满)
|
||||||
- 3 群:630166526 (人满)
|
- 3 群:630166526 (人满)
|
||||||
- 4 群:1077826412 (人满)
|
- 4 群:1077826412 (人满)
|
||||||
@@ -237,6 +233,14 @@ pre-commit install
|
|||||||
- 6 群:753075035 (人满)
|
- 6 群:753075035 (人满)
|
||||||
- 7 群:743746109 (人满)
|
- 7 群:743746109 (人满)
|
||||||
- 8 群:1030353265 (人满)
|
- 8 群:1030353265 (人满)
|
||||||
|
- 9 群:1076659624 (人满)
|
||||||
|
- 10 群:1078079676 (人满)
|
||||||
|
- 11 群:704659519 (人满)
|
||||||
|
- 12 群:916228568 (人满)
|
||||||
|
- 13 群:1092185289
|
||||||
|
- 14 群:1103419483
|
||||||
|
|
||||||
|
|
||||||
- 开发者群(偏闲聊吹水):975206796
|
- 开发者群(偏闲聊吹水):975206796
|
||||||
- 开发者群(正式):1039761811
|
- 开发者群(正式):1039761811
|
||||||
|
|
||||||
|
|||||||
@@ -16,10 +16,6 @@ Welcome to submit Issues or Pull Requests:
|
|||||||
|
|
||||||
### Tencent QQ Groups
|
### Tencent QQ Groups
|
||||||
|
|
||||||
- Group 12: 916228568 (New)
|
|
||||||
- Group 9: 1076659624 (Full)
|
|
||||||
- Group 10: 1078079676 (Full)
|
|
||||||
- Group 11: 704659519 (Full)
|
|
||||||
- Group 1: 322154837 (Full)
|
- Group 1: 322154837 (Full)
|
||||||
- Group 3: 630166526 (Full)
|
- Group 3: 630166526 (Full)
|
||||||
- Group 4: 1077826412 (Full)
|
- Group 4: 1077826412 (Full)
|
||||||
@@ -27,6 +23,12 @@ Welcome to submit Issues or Pull Requests:
|
|||||||
- Group 6: 753075035 (Full)
|
- Group 6: 753075035 (Full)
|
||||||
- Group 7: 743746109 (Full)
|
- Group 7: 743746109 (Full)
|
||||||
- Group 8: 1030353265 (Full)
|
- Group 8: 1030353265 (Full)
|
||||||
|
- Group 9: 1076659624 (Full)
|
||||||
|
- Group 10: 1078079676 (Full)
|
||||||
|
- Group 11: 704659519 (Full)
|
||||||
|
- Group 12: 916228568 (Full)
|
||||||
|
- Group 13: 1092185289
|
||||||
|
- Group 14: 1103419483
|
||||||
- **AstrBot Core Development Group: 975206796** (AstrBot development members are usually active here. Welcome to anyone interested in programming/AI technology~)
|
- **AstrBot Core Development Group: 975206796** (AstrBot development members are usually active here. Welcome to anyone interested in programming/AI technology~)
|
||||||
|
|
||||||
## Become an AstrBot Organization Member
|
## Become an AstrBot Organization Member
|
||||||
|
|||||||
@@ -288,12 +288,13 @@ Whether to enable AstrBot's built-in web search capability. Default is `false`.
|
|||||||
|
|
||||||
#### `provider_settings.websearch_provider`
|
#### `provider_settings.websearch_provider`
|
||||||
|
|
||||||
Web search provider type. Default is `tavily`. Currently supports `tavily`, `bocha`, `baidu_ai_search`, and `brave`.
|
Web search provider type. Default is `tavily`. Currently supports `tavily`, `bocha`, `baidu_ai_search`, `brave`, and `firecrawl`.
|
||||||
|
|
||||||
- `tavily`: Uses the Tavily search engine.
|
- `tavily`: Uses the Tavily search engine.
|
||||||
- `bocha`: Uses the BoCha search engine.
|
- `bocha`: Uses the BoCha search engine.
|
||||||
- `baidu_ai_search`: Uses Baidu AI Search (MCP).
|
- `baidu_ai_search`: Uses Baidu AI Search (MCP).
|
||||||
- `brave`: Uses Brave Search API.
|
- `brave`: Uses Brave Search API.
|
||||||
|
- `firecrawl`: Uses the Firecrawl Search API.
|
||||||
|
|
||||||
#### `provider_settings.websearch_tavily_key`
|
#### `provider_settings.websearch_tavily_key`
|
||||||
|
|
||||||
@@ -307,6 +308,10 @@ API Key list for the BoCha search engine. Required when using `bocha` as the web
|
|||||||
|
|
||||||
API Key list for the Brave search engine. Required when using `brave` as the web search provider.
|
API Key list for the Brave search engine. Required when using `brave` as the web search provider.
|
||||||
|
|
||||||
|
#### `provider_settings.websearch_firecrawl_key`
|
||||||
|
|
||||||
|
API Key list for the Firecrawl search engine. Required when using `firecrawl` as the web search provider.
|
||||||
|
|
||||||
#### `provider_settings.web_search_link`
|
#### `provider_settings.web_search_link`
|
||||||
|
|
||||||
Whether to prompt the model to include links to search results in the reply. Default is `false`.
|
Whether to prompt the model to include links to search results in the reply. Default is `false`.
|
||||||
|
|||||||
@@ -4,7 +4,12 @@ After completing your plugin development, you can choose to publish it to the As
|
|||||||
|
|
||||||
AstrBot uses GitHub to host plugins, so you'll need to push your plugin code to the GitHub plugin repository you created earlier.
|
AstrBot uses GitHub to host plugins, so you'll need to push your plugin code to the GitHub plugin repository you created earlier.
|
||||||
|
|
||||||
You can submit your plugin by visiting the [AstrBot Plugin Marketplace](https://plugins.astrbot.app). Once on the website, click the `+` button in the bottom-right corner, fill in the basic information, author details, repository information, and other required fields. Then click the `Submit to GITHUB` button. You will be redirected to the AstrBot repository's Issue submission page. Please verify that all information is correct, then click the `Create` button to complete the plugin publication process.
|
You can submit your plugin by visiting the [AstrBot Plugin Marketplace](https://plugins.astrbot.app). Once on the website, click the `+` button in the bottom-right corner, fill in the basic information, author details, repository information, and other required fields. Then click the `Submit to GITHUB` button.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> **Main repository Issue submission is deprecated**: The previous method of submitting plugins via Issues in the AstrBot main repository is no longer used. Please submit your plugin at the **[AstrBot_Plugins_Collection](https://github.com/AstrBotDevs/AstrBot_Plugins_Collection)** repository.
|
||||||
|
|
||||||
|
You will be redirected to the AstrBot_Plugins_Collection repository's Issue submission page. Please verify that all information is correct, then click the `Create` button to complete the plugin publication process.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
@@ -100,7 +100,7 @@ After restart, AstrBot will reload or download WebUI files that match the curren
|
|||||||
|
|
||||||
### No Permission to Execute Admin Commands
|
### No Permission to Execute Admin Commands
|
||||||
|
|
||||||
1. `/reset, /persona, /dashboard_update, /op, /deop, /wl, /dewl` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to the admin ID list in Settings -> Other Settings.
|
1. `/name, /provider, /dashboard_update, /op, /deop, /persona, /llm, /plugin, /model, /groupnew` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to the admin ID list in Settings -> Other Settings.
|
||||||
|
|
||||||
### Chinese Characters Garbled When Locally Rendering Markdown Images (t2i)
|
### Chinese Characters Garbled When Locally Rendering Markdown Images (t2i)
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,8 @@ The following commands are shipped with AstrBot and loaded by default:
|
|||||||
- `/reset`: Reset the current conversation's LLM context.
|
- `/reset`: Reset the current conversation's LLM context.
|
||||||
- `/stop`: Stop Agent tasks currently running in the current session.
|
- `/stop`: Stop Agent tasks currently running in the current session.
|
||||||
- `/new`: Create and switch to a new conversation.
|
- `/new`: Create and switch to a new conversation.
|
||||||
|
- `/stats`: View token usage statistics for the current conversation.
|
||||||
|
- `/provider`: View or switch LLM Provider. This command requires admin permission.
|
||||||
- `/dashboard_update`: Update AstrBot WebUI. This command requires admin permission.
|
- `/dashboard_update`: Update AstrBot WebUI. This command requires admin permission.
|
||||||
- `/set`: Set a session variable, commonly used for Agent Runner input variables such as Dify, Coze, or DashScope.
|
- `/set`: Set a session variable, commonly used for Agent Runner input variables such as Dify, Coze, or DashScope.
|
||||||
- `/unset`: Remove a session variable.
|
- `/unset`: Remove a session variable.
|
||||||
@@ -102,6 +104,45 @@ For third-party Agent Runners such as `dify`, `coze`, `dashscope`, and `deerflow
|
|||||||
|
|
||||||
If there are no running tasks in the current session, AstrBot will report that no task is running.
|
If there are no running tasks in the current session, AstrBot will report that no task is running.
|
||||||
|
|
||||||
|
### `/stats`
|
||||||
|
|
||||||
|
`/stats` shows token usage statistics for the current conversation.
|
||||||
|
|
||||||
|
It queries the database for all Provider call records in the current conversation and displays:
|
||||||
|
|
||||||
|
- Total tokens (input + output).
|
||||||
|
- Input tokens (cached) — input tokens that were cached by the provider and skipped for billing.
|
||||||
|
- Input tokens (other) — input tokens that were not cached and billed normally.
|
||||||
|
- Output tokens — tokens generated by the model.
|
||||||
|
|
||||||
|
If you are not in a conversation, AstrBot will prompt you to create one with `/new`.
|
||||||
|
|
||||||
|
### `/provider`
|
||||||
|
|
||||||
|
`/provider` views or switches the Provider (LLM / TTS / STT) used by the current UMO.
|
||||||
|
|
||||||
|
**Viewing the Provider list:**
|
||||||
|
|
||||||
|
With no arguments, `/provider` lists all configured Providers grouped by LLM, TTS, and STT. Each Provider shows:
|
||||||
|
|
||||||
|
- An index number for switching.
|
||||||
|
- Provider ID and the model currently in use (LLM type).
|
||||||
|
- Reachability status: `✅` means the connection is healthy, `❌` means a connection failure (with an error code).
|
||||||
|
- The currently active Provider is marked with `(currently in use)` at the end.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> Reachability checks must be enabled in WebUI under `Config -> General Config -> AI Config`, expand the "More Settings" section at the bottom, and enable "Provider Reachability Check". When disabled, reachability markers are not shown and the list loads faster.
|
||||||
|
|
||||||
|
**Switching Providers:**
|
||||||
|
|
||||||
|
Use `/provider <index>` to switch the current session's LLM Provider to the Provider at the given index in the list.
|
||||||
|
|
||||||
|
- `/provider <index>`: Switch to the LLM Provider at the given index.
|
||||||
|
- `/provider tts <index>`: Switch to the TTS Provider at the given index.
|
||||||
|
- `/provider stt <index>`: Switch to the STT Provider at the given index.
|
||||||
|
|
||||||
|
This command requires admin permission.
|
||||||
|
|
||||||
## Built-in Commands Extension
|
## Built-in Commands Extension
|
||||||
|
|
||||||
Other commands that were previously shipped with the core have been moved to a separate plugin:
|
Other commands that were previously shipped with the core have been moved to a separate plugin:
|
||||||
|
|||||||
@@ -14,11 +14,11 @@ When using a large language model that supports function calling with the web se
|
|||||||
|
|
||||||
And other prompts with search intent to trigger the model to invoke the search tool.
|
And other prompts with search intent to trigger the model to invoke the search tool.
|
||||||
|
|
||||||
AstrBot currently supports 4 web search providers: `Tavily`, `BoCha`, `Baidu AI Search`, and `Brave`.
|
AstrBot currently supports 5 web search providers: `Tavily`, `BoCha`, `Baidu AI Search`, `Brave`, and `Firecrawl`.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Go to `Configuration`, scroll down to find Web Search, where you can select `Tavily`, `BoCha`, `Baidu AI Search`, or `Brave`.
|
Go to `Configuration`, scroll down to find Web Search, where you can select `Tavily`, `BoCha`, `Baidu AI Search`, `Brave`, or `Firecrawl`.
|
||||||
|
|
||||||
### Tavily
|
### Tavily
|
||||||
|
|
||||||
@@ -36,6 +36,10 @@ Get an API Key from Baidu Qianfan APP Builder, then fill it in the corresponding
|
|||||||
|
|
||||||
Get an API Key from Brave Search, then fill it in the corresponding configuration item.
|
Get an API Key from Brave Search, then fill it in the corresponding configuration item.
|
||||||
|
|
||||||
|
### Firecrawl
|
||||||
|
|
||||||
|
Go to [Firecrawl](https://firecrawl.dev) to get an API Key, then fill it in the corresponding configuration item.
|
||||||
|
|
||||||
If you use Tavily as your web search source, you will get a better experience optimization on AstrBot ChatUI, including citation source display and more:
|
If you use Tavily as your web search source, you will get a better experience optimization on AstrBot ChatUI, including citation source display and more:
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
@@ -119,3 +119,6 @@ Modify the `port` in the `dashboard` configuration in the data/cmd_config.json f
|
|||||||
## Forgot Password
|
## Forgot Password
|
||||||
|
|
||||||
Modify the `password` in the `dashboard` configuration in the data/cmd_config.json file and delete the entire password key-value pair.
|
Modify the `password` in the `dashboard` configuration in the data/cmd_config.json file and delete the entire password key-value pair.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> For more details, see [FAQ - Forgot Dashboard Password](/en/faq.md#forgot-dashboard-password).
|
||||||
|
|||||||
@@ -6,17 +6,19 @@
|
|||||||
|
|
||||||
### QQ 群
|
### QQ 群
|
||||||
|
|
||||||
- 12 群: 916228568 (新)
|
- 1 群:322154837 (人满)
|
||||||
- 9 群: 1076659624 (人满)
|
- 3 群:630166526 (人满)
|
||||||
- 10 群: 1078079676 (人满)
|
- 4 群:1077826412 (人满)
|
||||||
- 11 群: 704659519 (人满)
|
- 5 群:822130018 (人满)
|
||||||
- 1 群: 322154837 (人满)
|
- 6 群:753075035 (人满)
|
||||||
- 3 群: 630166526 (人满)
|
- 7 群:743746109 (人满)
|
||||||
- 4 群: 1077826412 (人满)
|
- 8 群:1030353265 (人满)
|
||||||
- 5 群: 822130018 (人满)
|
- 9 群:1076659624 (人满)
|
||||||
- 6 群: 753075035 (人满)
|
- 10 群:1078079676 (人满)
|
||||||
- 7 群: 743746109 (人满)
|
- 11 群:704659519 (人满)
|
||||||
- 8 群: 1030353265 (人满)
|
- 12 群:916228568 (人满)
|
||||||
|
- 13 群:1092185289
|
||||||
|
- 14 群:1103419483
|
||||||
- **AstrBot 核心开发交流群: 975206796**(AstrBot 开发成员通常活跃于此,欢迎任何对编程/AI 技术感兴趣的同学加入~)
|
- **AstrBot 核心开发交流群: 975206796**(AstrBot 开发成员通常活跃于此,欢迎任何对编程/AI 技术感兴趣的同学加入~)
|
||||||
|
|
||||||
### Discord
|
### Discord
|
||||||
|
|||||||
@@ -288,12 +288,13 @@ ID 白名单。填写后,将只处理所填写的 ID 发来的消息事件。
|
|||||||
|
|
||||||
#### `provider_settings.websearch_provider`
|
#### `provider_settings.websearch_provider`
|
||||||
|
|
||||||
网页搜索提供商类型。默认为 `tavily`。目前支持 `tavily`、`bocha`、`baidu_ai_search`、`brave`。
|
网页搜索提供商类型。默认为 `tavily`。目前支持 `tavily`、`bocha`、`baidu_ai_search`、`brave`、`firecrawl`。
|
||||||
|
|
||||||
- `tavily`:使用 Tavily 搜索引擎。
|
- `tavily`:使用 Tavily 搜索引擎。
|
||||||
- `bocha`:使用 BoCha 搜索引擎。
|
- `bocha`:使用 BoCha 搜索引擎。
|
||||||
- `baidu_ai_search`:使用百度 AI Search(MCP)。
|
- `baidu_ai_search`:使用百度 AI Search(MCP)。
|
||||||
- `brave`:使用 Brave Search API。
|
- `brave`:使用 Brave Search API。
|
||||||
|
- `firecrawl`:使用 Firecrawl Search API。
|
||||||
|
|
||||||
#### `provider_settings.websearch_tavily_key`
|
#### `provider_settings.websearch_tavily_key`
|
||||||
|
|
||||||
@@ -307,6 +308,10 @@ BoCha 搜索引擎的 API Key 列表。使用 `bocha` 作为网页搜索提供
|
|||||||
|
|
||||||
Brave 搜索引擎的 API Key 列表。使用 `brave` 作为网页搜索提供商时需要填写。
|
Brave 搜索引擎的 API Key 列表。使用 `brave` 作为网页搜索提供商时需要填写。
|
||||||
|
|
||||||
|
#### `provider_settings.websearch_firecrawl_key`
|
||||||
|
|
||||||
|
Firecrawl 搜索引擎的 API Key 列表。使用 `firecrawl` 作为网页搜索提供商时需要填写。
|
||||||
|
|
||||||
#### `provider_settings.web_search_link`
|
#### `provider_settings.web_search_link`
|
||||||
|
|
||||||
是否在回复中提示模型附上搜索结果的链接。默认为 `false`。
|
是否在回复中提示模型附上搜索结果的链接。默认为 `false`。
|
||||||
|
|||||||
@@ -4,7 +4,12 @@
|
|||||||
|
|
||||||
AstrBot 使用 GitHub 托管插件,因此你需要先将插件代码推送到之前创建的 GitHub 插件仓库中。
|
AstrBot 使用 GitHub 托管插件,因此你需要先将插件代码推送到之前创建的 GitHub 插件仓库中。
|
||||||
|
|
||||||
你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后,点击右下角的 `+` 按钮,填写好基本信息、作者信息、仓库信息等内容后,点击 `提交到 GITHUB` 按钮,你将会被导航到 AstrBot 仓库的 Issue 提交页面,请确认信息无误后点击 `Create` 按钮提交,即可完成插件发布。
|
你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后,点击右下角的 `+` 按钮,填写好基本信息、作者信息、仓库信息等内容后,点击 `提交到 GITHUB` 按钮。
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> **主仓库 Issue 提交方式已废弃**:此前通过 AstrBot 主仓库 Issue 提交插件的方式已不再使用。现在请前往 **[AstrBot_Plugins_Collection](https://github.com/AstrBotDevs/AstrBot_Plugins_Collection)** 仓库提交你的插件。
|
||||||
|
|
||||||
|
你将会被导航到 AstrBot_Plugins_Collection 仓库的 Issue 提交页面,请确认信息无误后点击 `Create` 按钮提交,即可完成插件发布。
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
@@ -118,7 +118,7 @@ Set dashboard.host in data/cmd_config.json to enable remote access.
|
|||||||
|
|
||||||
### 没有权限操作管理员指令
|
### 没有权限操作管理员指令
|
||||||
|
|
||||||
1. `/reset, /persona, /dashboard_update, /op, /deop, /wl, /dewl` 是默认的管理员指令。可以通过 `/sid` 指令得到用户的 ID,然后在 `配置` -> `其他配置` 中添加到管理员 ID 名单中。
|
1. `/name, /provider, /dashboard_update, /op, /deop, /persona, /llm, /plugin, /model, /groupnew` 等是默认的管理员指令。可以通过 `/sid` 指令得到用户的 ID,然后在 `配置` -> `其他配置` 中添加到管理员 ID 名单中。
|
||||||
|
|
||||||
### 本地渲染 Markdown 图片(t2i)时中文乱码
|
### 本地渲染 Markdown 图片(t2i)时中文乱码
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,8 @@ AstrBot 的指令通过插件机制注册。为了保持主程序轻量,当前
|
|||||||
- `/reset`:重置当前会话的 LLM 上下文。
|
- `/reset`:重置当前会话的 LLM 上下文。
|
||||||
- `/stop`:停止当前会话中正在运行的 Agent 任务。
|
- `/stop`:停止当前会话中正在运行的 Agent 任务。
|
||||||
- `/new`:创建并切换到一个新对话。
|
- `/new`:创建并切换到一个新对话。
|
||||||
|
- `/stats`:查看当前会话的 Token 用量统计。
|
||||||
|
- `/provider`:查看或切换 LLM Provider。该指令需要管理员权限。
|
||||||
- `/dashboard_update`:更新 AstrBot WebUI。该指令需要管理员权限。
|
- `/dashboard_update`:更新 AstrBot WebUI。该指令需要管理员权限。
|
||||||
- `/set`:设置当前会话变量,常用于 Dify、Coze、DashScope 等 Agent 执行器的输入变量。
|
- `/set`:设置当前会话变量,常用于 Dify、Coze、DashScope 等 Agent 执行器的输入变量。
|
||||||
- `/unset`:移除当前会话变量。
|
- `/unset`:移除当前会话变量。
|
||||||
@@ -96,6 +98,45 @@ AstrBot 的指令通过插件机制注册。为了保持主程序轻量,当前
|
|||||||
|
|
||||||
如果当前会话没有正在运行的任务,AstrBot 会提示当前会话没有运行中的任务。
|
如果当前会话没有正在运行的任务,AstrBot 会提示当前会话没有运行中的任务。
|
||||||
|
|
||||||
|
### `/stats`
|
||||||
|
|
||||||
|
`/stats` 用于查看当前会话的 Token 用量统计。
|
||||||
|
|
||||||
|
它从数据库中查询当前对话的所有 Provider 调用记录,汇总并展示:
|
||||||
|
|
||||||
|
- 总 Token 用量(输入 Token + 输出 Token)。
|
||||||
|
- 输入 Token(缓存命中),即被提供商缓存并跳过计费的输入 Token。
|
||||||
|
- 输入 Token(其他),即未被缓存、正常计费的输入 Token。
|
||||||
|
- 输出 Token,即模型生成的输出 Token。
|
||||||
|
|
||||||
|
如果当前不在任何对话中,AstrBot 会提示先使用 `/new` 创建对话。
|
||||||
|
|
||||||
|
### `/provider`
|
||||||
|
|
||||||
|
`/provider` 用于查看或切换当前 UMO 使用的 Provider(LLM / TTS / STT)。
|
||||||
|
|
||||||
|
**查看 Provider 列表:**
|
||||||
|
|
||||||
|
不带参数时,`/provider` 会列出所有已配置的 Provider,按 LLM、TTS、STT 分类展示。每个 Provider 旁会显示:
|
||||||
|
|
||||||
|
- 序号,用于后续切换。
|
||||||
|
- Provider ID 和当前使用的模型(LLM 类型)。
|
||||||
|
- 可达性标记:`✅` 表示连接正常,`❌` 表示连接失败(附带错误码)。
|
||||||
|
- 当前正在使用的 Provider 末尾会标注 `(当前使用)`。
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 可达性检测需要在 WebUI 的 `配置 -> 普通配置 -> AI 配置` 中,展开底部的「更多配置」,开启「提供商可达性检测」后才会生效。关闭后不显示可达性标记,列表加载更快。
|
||||||
|
|
||||||
|
**切换 Provider:**
|
||||||
|
|
||||||
|
使用 `/provider <序号>` 可以将当前会话的 LLM Provider 切换为列表中对应序号的 Provider。
|
||||||
|
|
||||||
|
- `/provider <序号>`:切换到指定序号的 LLM Provider。
|
||||||
|
- `/provider tts <序号>`:切换到指定序号的 TTS Provider。
|
||||||
|
- `/provider stt <序号>`:切换到指定序号的 STT Provider。
|
||||||
|
|
||||||
|
该指令需要管理员权限。
|
||||||
|
|
||||||
## 内置指令扩展
|
## 内置指令扩展
|
||||||
|
|
||||||
除上述基础指令外,其他原本随主程序提供的内置指令已经迁移到独立插件:
|
除上述基础指令外,其他原本随主程序提供的内置指令已经迁移到独立插件:
|
||||||
|
|||||||
@@ -13,11 +13,11 @@ AstrBot 内置的网页搜索功能依赖大模型提供 `函数调用` 能力
|
|||||||
|
|
||||||
等等带有搜索意味的提示让大模型触发调用搜索工具。
|
等等带有搜索意味的提示让大模型触发调用搜索工具。
|
||||||
|
|
||||||
AstrBot 当前支持 4 种网页搜索源接入方式:`Tavily`、`BoCha`、`百度 AI 搜索`、`Brave`。
|
AstrBot 当前支持 5 种网页搜索源接入方式:`Tavily`、`BoCha`、`百度 AI 搜索`、`Brave`、`Firecrawl`。
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
进入 `配置`,下拉找到网页搜索,您可选择 `Tavily`、`BoCha`、`百度 AI 搜索` 或 `Brave`。
|
进入 `配置`,下拉找到网页搜索,您可选择 `Tavily`、`BoCha`、`百度 AI 搜索`、`Brave` 或 `Firecrawl`。
|
||||||
|
|
||||||
### Tavily
|
### Tavily
|
||||||
|
|
||||||
@@ -35,6 +35,10 @@ AstrBot 当前支持 4 种网页搜索源接入方式:`Tavily`、`BoCha`、`
|
|||||||
|
|
||||||
前往 Brave Search 获取 API Key,然后填写在相应的配置项。
|
前往 Brave Search 获取 API Key,然后填写在相应的配置项。
|
||||||
|
|
||||||
|
### Firecrawl
|
||||||
|
|
||||||
|
前往 [Firecrawl](https://firecrawl.dev) 获取 API Key,然后填写在相应的配置项。
|
||||||
|
|
||||||
如果您使用 Tavily 作为网页搜索源,在 AstrBot ChatUI 上将会获得更好的体验优化,包括引用来源展示等:
|
如果您使用 Tavily 作为网页搜索源,在 AstrBot ChatUI 上将会获得更好的体验优化,包括引用来源展示等:
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
@@ -119,3 +119,6 @@ ChatUI 支持以下常用能力:
|
|||||||
## 忘记密码
|
## 忘记密码
|
||||||
|
|
||||||
修改 data/cmd_config.json 文件内 `dashboard` 配置中的 `password`,将 password 整个键值对删除。
|
修改 data/cmd_config.json 文件内 `dashboard` 配置中的 `password`,将 password 整个键值对删除。
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> 详细说明请参阅 [FAQ - 管理面板的密码忘记了](/faq.md#管理面板的密码忘记了)。
|
||||||
|
|||||||
Reference in New Issue
Block a user