Skip to content

Commit 2cfce16

Browse files
committed
feat(docs): 更新功能特性和 API 网关文档
1 parent a4f2595 commit 2cfce16

8 files changed

Lines changed: 17 additions & 57 deletions

File tree

website/docs/features.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Connect to the leading AI providers from a single, unified interface. AQBot hand
1313
- **Message Versions** — Every response can have multiple versions. Switch between them to compare the effects of different models or parameter settings side by side.
1414
- **Conversation Branching** — Fork a new branch from any message node to explore alternative directions. A side-by-side branch comparison view makes it easy to evaluate different paths.
1515
- **Conversation Management** — Pin important conversations, archive old ones, browse a time-grouped history, and perform bulk operations to keep your workspace tidy.
16+
- **Conversation Compression** — Automatically compress lengthy conversations, preserving key information to save context space.
17+
- **Multi-Model Simultaneous Response** — Ask the same question to multiple models at once, with side-by-side comparison of answers.
1618

1719
## Content Rendering
1820

@@ -22,7 +24,7 @@ AQBot goes far beyond plain-text chat with a rich, interactive rendering pipelin
2224
- **Monaco Code Editor** — Code blocks embed the Monaco Editor (the engine behind VS Code) with syntax highlighting, one-click copy, and inline diff preview.
2325
- **Diagram Rendering** — Built-in rendering for Mermaid flowcharts and D2 architecture diagrams, displayed directly in the conversation.
2426
- **Artifact Panel** — Code snippets, HTML drafts, Markdown notes, and reports can be opened in a dedicated side panel for focused viewing and editing.
25-
- **Real-Time Voice Chat** — WebRTC-based voice conversations powered by the OpenAI Realtime API for low-latency, natural interaction.
27+
- **Real-Time Voice Chat**(Coming Soon) WebRTC-based voice conversations powered by the OpenAI Realtime API for low-latency, natural interaction.
2628

2729
## Search & Knowledge
2830

@@ -42,9 +44,8 @@ The Local Knowledge Base and Memory System are under active development and will
4244
Extend the model's capabilities with external tools and a powerful command interface.
4345

4446
- **MCP Protocol** — Full [Model Context Protocol](https://modelcontextprotocol.io/) implementation supporting both **stdio** and **HTTP** transports. Connect to local tool servers or remote endpoints seamlessly.
45-
- **Built-in Tools** — Ready-to-use tools including file read/write, shell execution, and screenshot capture — no extra setup required.
47+
- **Built-in Tools** — Ready-to-use built-in MCP tools such as `@aqbot/fetch` — no extra setup required.
4648
- **Tool Execution Panel** — A visual panel displays each tool-call request and its return result, making it easy to audit and debug tool interactions.
47-
- **Command Palette** — Press `Cmd/Ctrl+K` to open a global command palette for quick navigation, actions, and search across the entire app.
4849

4950
## API Gateway
5051

@@ -53,7 +54,6 @@ AQBot includes a built-in local API server that turns your desktop app into a po
5354
- **Local API Gateway** — Expose a local server with native support for OpenAI-compatible, Claude, and Gemini interfaces. Use it as a backend for CLI tools, scripts, or other applications.
5455
- **API Key Management** — Generate, revoke, and enable or disable access keys. Each key supports a description note for easy identification.
5556
- **Usage Analytics** — Analyze request volume and token usage broken down by key, provider, and date to understand consumption patterns.
56-
- **Program Policies** — Configure model whitelists and rate limits independently per connected application for fine-grained access control.
5757
- **SSL/TLS Support** — Built-in self-signed certificate generation with support for importing custom certificates.
5858
- **Request Logs** — Complete recording of every API request and response passing through the gateway for auditing and debugging.
5959
- **Configuration Templates** — Pre-built integration templates for popular tools such as Claude Code, Codex CLI, OpenCode, and Gemini CLI so you can get started in seconds.
@@ -68,7 +68,7 @@ Your data never leaves your machine. AQBot is designed with local-first security
6868

6969
- **AES-256 Encryption** — API keys and other sensitive data are encrypted locally with AES-256. The master encryption key is stored with `0600` file permissions (owner-only access on Unix systems).
7070
- **Isolated Data Directories** — Application state (database, encryption keys, vector indices) lives in `~/.aqbot/`. User-visible files (images, documents, backups) are stored in `~/Documents/aqbot/` for easy access and backup with standard OS tools.
71-
- **Auto Backup** — Schedule automatic backups to local directories, WebDAV servers, or S3-compatible object storage.
71+
- **Auto Backup** — Schedule automatic backups to local directories or WebDAV storage.
7272
- **Backup Restore** — One-click restore from any historical backup to recover your full workspace.
7373
- **Conversation Export** — Export conversations as PNG screenshots, Markdown documents, plain text, or structured JSON.
7474

website/docs/guide/gateway.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,6 @@ Treat gateway keys like any other API key. Anyone with the key can send requests
4141

4242
---
4343

44-
## Program Policies
45-
46-
Program policies let you control which models each connected tool can access and how fast it can make requests.
47-
48-
| Setting | Description |
49-
|---------|-------------|
50-
| **Model whitelist** | Restrict the tool to a specific set of models. Requests for unlisted models are rejected. |
51-
| **Rate limiting** | Cap the number of requests per minute for this tool. |
52-
53-
Create policies in the **Program Policies** section of the gateway settings.
54-
55-
---
56-
5744
## SSL/TLS
5845

5946
The gateway can serve HTTPS alongside or instead of HTTP.

website/docs/guide/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Go to **Settings → Backup** to configure automatic backups:
173173
- **Enabled** — toggle automatic backups on or off.
174174
- **Interval** — how often to back up (in hours).
175175
- **Max count** — number of backups to keep before the oldest is deleted.
176-
- **Storage target** — local directory (default: `~/Documents/aqbot/backups/`), WebDAV server, or S3-compatible storage.
176+
- **Storage target** — local directory (default: `~/Documents/aqbot/backups/`) or WebDAV server.
177177

178178
### Manual Backup & Restore
179179

website/docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ features:
3232
details: Connect to OpenAI, Claude, Gemini, DeepSeek, Qwen, and any OpenAI-compatible API. Multi-key rotation, streaming output, and thinking blocks.
3333
- icon: 🔌
3434
title: MCP Tool Calling
35-
details: Full Model Context Protocol support — stdio, SSE, StreamableHTTP. Connect external tools with one click. Built-in file, shell, and screenshot tools.
35+
details: Full Model Context Protocol support — stdio, SSE, StreamableHTTP. Connect external tools with one click. Built-in MCP tools like @aqbot/fetch.
3636
- icon: 🌐
3737
title: Built-in API Gateway
3838
details: Local OpenAI-compatible API server. Use AQBot as the backend for Claude Code, Codex, Gemini CLI, and more. Key management, rate limiting, SSL/TLS.
@@ -47,8 +47,8 @@ features:
4747
details: Markdown, LaTeX, Mermaid diagrams, D2 architecture diagrams, Monaco Code Editor with diff preview, and Artifact panels.
4848
- icon: ⌨️
4949
title: Desktop Experience
50-
details: Global shortcuts, system tray, auto-start, always-on-top, command palette (Cmd/Ctrl+K), dark/light themes, and proxy support.
50+
details: Global shortcuts, system tray, auto-start, always-on-top, dark/light themes, and proxy support.
5151
- icon: 🔒
5252
title: Privacy & Security
53-
details: All data stored locally. AES-256 encrypted API keys. Auto backup to local, WebDAV, or S3. Conversation export as PNG/Markdown/JSON.
53+
details: All data stored locally. AES-256 encrypted API keys. Auto backup to local or WebDAV. Conversation export as PNG/Markdown/JSON.
5454
---

website/docs/zh/features.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ AQBot 提供灵活强大的多模型对话能力,让你在一个客户端中
1313
- **消息版本** — 每条回复支持保存多个版本,方便对比不同模型或参数下的生成效果
1414
- **对话分支** — 从任意消息节点派生新分支,探索不同对话方向,支持分支间对比
1515
- **对话管理** — 支持置顶、归档、按时间分组、批量操作等多种管理方式
16+
- **对话压缩** — 自动压缩冗长对话,保留关键信息以节省上下文空间
17+
- **多模型同答** — 同一问题同时向多个模型提问,支持答案间对比分析
1618

1719
::: tip 提示
1820
配置多个 API Key 后,AQBot 会自动在请求之间轮换密钥,即使单个密钥触发速率限制也不会中断使用。
@@ -26,7 +28,7 @@ AI 回复中的各种格式内容都能得到精准渲染,提供出色的阅
2628
- **Monaco 代码编辑器** — 代码块内嵌 Monaco Editor,支持语法高亮、一键复制和 diff 预览
2729
- **图表渲染** — 内置 Mermaid 流程图与 D2 架构图渲染引擎,直接在对话中可视化图表
2830
- **Artifact 面板** — 代码片段、HTML 草稿、Markdown 笔记、报告等内容可在独立面板中实时预览
29-
- **实时语音对话** 基于 WebRTC 的实时语音交互,兼容 OpenAI Realtime API
31+
- **实时语音对话**(即将推出)基于 WebRTC 的实时语音交互,兼容 OpenAI Realtime API
3032

3133
## 搜索与知识
3234

@@ -46,9 +48,8 @@ AI 回复中的各种格式内容都能得到精准渲染,提供出色的阅
4648
通过 MCP 协议和内置工具,让 AI 具备操作外部系统的能力。
4749

4850
- **MCP 协议** — 完整实现 [Model Context Protocol](https://modelcontextprotocol.io/),支持 stdio 和 HTTP 两种传输方式
49-
- **内置工具**提供文件读写、Shell 命令执行、截图等开箱即用的内置工具
51+
- **内置工具**提供 `@aqbot/fetch` 等开箱即用的内置 MCP 工具
5052
- **工具执行面板** — 可视化展示工具调用的请求参数与返回结果,方便调试和审查
51-
- **命令面板**`Cmd/Ctrl+K` 唤起全局命令面板,快速跳转和执行各种操作
5253

5354
## API 网关
5455

@@ -57,7 +58,6 @@ AQBot 内置一个功能完整的本地 API 网关,让你的其他工具也能
5758
- **本地 API 服务器** — 提供 OpenAI 兼容、Claude 原生、Gemini 原生等多种接口格式,可作为任意兼容客户端的后端
5859
- **API 密钥管理** — 生成、撤销、启停访问密钥,支持描述备注
5960
- **用量统计** — 按密钥、供应商、日期等维度统计请求量与 Token 用量
60-
- **程序策略** — 为每个接入程序独立配置模型白名单与速率限制
6161
- **SSL/TLS 支持** — 内置自签名证书自动生成,也支持挂载自定义证书
6262
- **请求日志** — 完整记录所有经过网关的 API 请求与响应,便于排查问题
6363
- **配置模板** — 预置 Claude Code、Codex CLI、OpenCode、Gemini CLI 等常见工具的接入配置模板,开箱即用
@@ -72,7 +72,7 @@ AQBot 将隐私和数据安全放在首位,所有数据完全存储在本地
7272

7373
- **AES-256 加密** — API Key 等敏感数据使用 AES-256 加密存储于本地数据库,主密钥文件权限设为 `0600`
7474
- **数据目录隔离** — 应用状态存储于 `~/.aqbot/`,用户文件(图片、文档、备份)存储于 `~/Documents/aqbot/`,互不干扰
75-
- **自动备份** — 支持定时自动备份到本地目录、WebDAV 或 S3 兼容的对象存储
75+
- **自动备份** — 支持定时自动备份到本地目录、WebDAV 存储
7676
- **备份恢复** — 一键从历史备份恢复完整数据
7777
- **对话导出** — 支持将对话导出为 PNG 截图、Markdown、纯文本或 JSON 格式
7878

website/docs/zh/guide/gateway.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -63,30 +63,6 @@ curl http://127.0.0.1:39876/v1/models \
6363

6464
为每个密钥添加描述可以帮助你管理多个客户端的访问。例如区分不同工具或团队成员使用的密钥。
6565

66-
## 程序策略
67-
68-
通过程序策略,你可以对连接到网关的不同程序设置精细的访问控制。
69-
70-
### 模型白名单
71-
72-
为每个程序指定允许使用的服务商和模型。未在白名单中的模型将被拒绝访问。
73-
74-
### 默认模型
75-
76-
为程序指定默认的服务商和模型。当客户端请求不指定模型时,使用此默认配置。
77-
78-
### 速率限制
79-
80-
为每个程序设置每分钟的最大请求次数。超过限制的请求将返回 429 状态码。
81-
82-
| 配置项 | 说明 |
83-
|-------|------|
84-
| 程序名称 | 连接程序的标识名称 |
85-
| 允许的服务商 | 该程序可以使用哪些服务商 |
86-
| 允许的模型 | 该程序可以使用哪些模型 |
87-
| 默认服务商/模型 | 未指定时使用的默认值 |
88-
| 速率限制 | 每分钟最大请求数 |
89-
9066
## SSL/TLS
9167

9268
网关支持 HTTPS 加密通信,部分工具(如 Claude Code)要求使用 HTTPS 连接。
@@ -223,7 +199,6 @@ gemini
223199
::: tip 统一管理的优势
224200
通过 API 网关统一管理,你可以:
225201
- 在 AQBot 中集中管理所有服务商密钥,其他工具只需一个网关密钥
226-
- 通过程序策略控制每个工具可以访问的模型
227202
- 在用量统计中查看所有工具的使用情况
228203
- 利用多密钥轮询提高可靠性
229204
:::

website/docs/zh/guide/getting-started.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,6 @@ AQBot 内置了一套常用快捷键,提升操作效率:
132132
|-------|------|
133133
| `CmdOrCtrl+Shift+A` | 显示/隐藏当前窗口 |
134134
| `CmdOrCtrl+Shift+Z` | 显示/隐藏所有窗口 |
135-
| `Cmd/Ctrl+K` | 打开命令面板 |
136135
| `Cmd/Ctrl+N` | 新建对话 |
137136
| `Cmd/Ctrl+,` | 打开设置 |
138137
| `Cmd/Ctrl+F` | 搜索对话 |
@@ -188,7 +187,6 @@ AQBot 使用两个目录分别存储不同类型的数据:
188187

189188
- **本地** — 默认保存到 `~/Documents/aqbot/backups/`
190189
- **WebDAV** — 同步到支持 WebDAV 的网盘(如坚果云)
191-
- **S3** — 备份到兼容 S3 协议的对象存储
192190

193191
可配置备份间隔(小时)和保留的最大备份数量。
194192

website/docs/zh/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ features:
3535
details: 接入 OpenAI、Claude、Gemini、DeepSeek、Qwen 等所有兼容 API。多密钥轮询、流式输出、Thinking 折叠展开。
3636
- icon: 🔌
3737
title: MCP 工具调用
38-
details: 完整实现 Model Context Protocol,支持 stdio、SSE、StreamableHTTP。一键连接外部工具,内置文件、Shell、截图工具
38+
details: 完整实现 Model Context Protocol,支持 stdio、SSE、StreamableHTTP。一键连接外部工具,内置 @aqbot/fetch 等 MCP 工具
3939
- icon: 🌐
4040
title: 内置 API 网关
4141
details: 本地 OpenAI 兼容 API 服务器,可作为 Claude Code、Codex、Gemini CLI 等工具的后端。密钥管理、速率限制、SSL/TLS。
@@ -50,8 +50,8 @@ features:
5050
details: Markdown、LaTeX 公式、Mermaid 流程图、D2 架构图、Monaco 代码编辑器 diff 预览、Artifact 独立面板。
5151
- icon: ⌨️
5252
title: 桌面体验
53-
details: 全局快捷键、系统托盘、开机自启、窗口置顶、命令面板(Cmd/Ctrl+K)、深浅主题、代理支持。
53+
details: 全局快捷键、系统托盘、开机自启、窗口置顶、深浅主题、代理支持。
5454
- icon: 🔒
5555
title: 隐私安全
56-
details: 所有数据本地存储,AES-256 加密 API 密钥。支持自动备份到本地、WebDAV、S3。对话导出为 PNG/Markdown/JSON。
56+
details: 所有数据本地存储,AES-256 加密 API 密钥。支持自动备份到本地、WebDAV。对话导出为 PNG/Markdown/JSON。
5757
---

0 commit comments

Comments
 (0)