-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
docs: 文档更新 - 指令、FAQ、网页搜索、插件发布等 #8912
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NayukiChiba
wants to merge
5
commits into
AstrBotDevs:master
Choose a base branch
from
NayukiChiba:docs/overhaul
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f0900d4
docs(community): 更新 QQ 群组信息
NayukiChiba 4ccbf9a
docs(webui): 为忘记密码章节添加 FAQ 引用链接
NayukiChiba 2a77b25
docs(command): 新增 /stats 和 /provider 指令文档,更新 FAQ 管理员指令列表
NayukiChiba 861fa16
docs(websearch): 新增 Firecrawl 网页搜索提供商文档支持
NayukiChiba 5bf1003
docs(plugin-publish): 更新插件提交方式至新仓库
NayukiChiba File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -18,6 +18,8 @@ The following commands are shipped with AstrBot and loaded by default: | |||||
| - `/reset`: Reset the current conversation's LLM context. | ||||||
| - `/stop`: Stop Agent tasks currently running in the current session. | ||||||
| - `/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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 根据下文第 122 行的详细说明,
Suggested change
|
||||||
| - `/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. | ||||||
| - `/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. | ||||||
|
|
||||||
| ### `/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 | ||||||
|
|
||||||
| Other commands that were previously shipped with the core have been moved to a separate plugin: | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,8 @@ AstrBot 的指令通过插件机制注册。为了保持主程序轻量,当前 | |
| - `/reset`:重置当前会话的 LLM 上下文。 | ||
| - `/stop`:停止当前会话中正在运行的 Agent 任务。 | ||
| - `/new`:创建并切换到一个新对话。 | ||
| - `/stats`:查看当前会话的 Token 用量统计。 | ||
| - `/provider`:查看或切换 LLM Provider。该指令需要管理员权限。 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| - `/dashboard_update`:更新 AstrBot WebUI。该指令需要管理员权限。 | ||
| - `/set`:设置当前会话变量,常用于 Dify、Coze、DashScope 等 Agent 执行器的输入变量。 | ||
| - `/unset`:移除当前会话变量。 | ||
|
|
@@ -96,6 +98,45 @@ 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。 | ||
|
|
||
| 该指令需要管理员权限。 | ||
|
|
||
| ## 内置指令扩展 | ||
|
|
||
| 除上述基础指令外,其他原本随主程序提供的内置指令已经迁移到独立插件: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
在
docs/en/faq.md中,第 91 行使用的是Config -> Other Config,而第 103 行使用的是Settings -> Other Settings。为了保持英文文档中界面术语的一致性,建议将Settings -> Other Settings统一修改为Config -> Other Config。