feat(desktop): embed BoosAPI Desktop client as a subproject

Vendor the rebranded BoosAPI Desktop client (Tauri + Vue) into metapi as
a monorepo subdirectory under desktop/. Source only — node_modules,
dist, Cargo target and the upstream .git history are excluded.

desktop/ keeps its own independent Cargo workspace (desktop/src-tauri
with crates/*); it is not part of the backend boosapi crate, so a
`cargo check` at the metapi root still compiles only the backend. Build
the desktop app from desktop/src-tauri per desktop/README.md.

Note: app icons are still placeholder assets pending the final BoosAPI
logo. The updater signing keys live outside the repo and are not
included.
This commit is contained in:
boos
2026-06-22 11:32:57 +08:00
parent d9c78ecc73
commit e0a5f57793
2305 changed files with 449355 additions and 0 deletions
+5
View File
@@ -0,0 +1,5 @@
---
layout: page
---
<DownloadHero />
+52
View File
@@ -0,0 +1,52 @@
# 功能特性
BoosApi 是本機優先的 AI 桌面工作台。本頁已依 v0.0.85 更新,涵蓋近期服務供應商匯入、第三方資料匯入、MCP、HTML 渲染、備份和閘道能力。
## 對話與模型
- **多服務供應商對話** — 連接 OpenAI、Claude、Gemini、DeepSeek、Qwen 以及任意 OpenAI 相容端點,支援自訂 Base URL、API Path、請求頭和代理規則。
- **服務供應商快速匯入** — 透過 boosapi:// 服務供應商連結和 CC Switch 設定匯入,在使用者確認後把服務供應商資料帶入 BoosApi。
- **模型管理** — 同步遠端模型列表、管理分組、測試延遲,並設定能力標籤、上下文長度、採樣預設值、推理檔位和模型級 extra_body。
- **對話工作流** — 流式回覆、思考區塊、訊息多版本、對話分支、標題生成狀態、長對話壓縮和多模型並行回答。
## AI Agent
- **Agent 模式** — 讓模型在受控桌面工作流中讀取/編輯檔案、執行命令並分析程式碼。
- **權限控制** — 可選擇標準審核、自動接受編輯或完全存取模式,同時保留工作目錄沙箱檢查。
- **審批與成本面板** — 即時查看工具呼叫、記住允許決策,並追蹤每個 Agent 會話的 token 與成本。
## 內容渲染
- **Markdown 與數學公式** — 在流式對話中渲染 Markdown、程式碼高亮、表格、任務列表和 LaTeX 公式。
- **程式碼、圖表與 Artifact** — 內建 Monaco 程式碼區塊、Mermaid、D2 圖表和 Artifact 面板,用於程式碼、Markdown 筆記、報告和預覽。
- **HTML 片段渲染** — 安全預覽模型生成的 HTML 片段,並包含近期版本加入的流式渲染穩定性修復。
## 搜尋與知識
- **網路搜尋** — 接入 Tavily、智譜 WebSearch、Bocha 等搜尋服務,支援引用來源和搜尋查詢生成。
- **本機知識庫** — 用 sqlite-vec 索引私有文件,設定檢索/重排選項並查看檢索回饋。
- **上下文管理** — 把檔案、搜尋結果、知識片段、記憶和工具輸出附加到對話上下文。
## 工具與擴充
- **MCP 協定** — 執行 stdio、SSE 或 StreamableHTTP 傳輸的 Model Context Protocol 伺服器。
- **內建工具** — 直接使用 @boosapi/fetch、檔案搜尋等內建 MCP 工具,無需額外安裝獨立伺服器。
- **工具循環上限** — 可設定 MCP 工具呼叫最大循環次數,並更好地恢復中斷或卡住的工具會話。
## API 閘道
- **本機閘道** — 從桌面應用暴露 OpenAI Chat Completions、OpenAI Responses、Claude 原生和 Gemini 原生介面。
- **存取與觀測** — 本機管理閘道金鑰、SSL/TLS 憑證、請求日誌和用量統計。
- **客戶端範本** — 提供 Claude Code、Codex CLI、OpenCode、Gemini CLI 和自訂客戶端的設定範本。
## 資料匯入與備份
- **第三方匯入** — 匯入 ChatGPT 官方匯出、Cherry Studio 備份和 Kelivo 備份,帶預覽統計、警告和重複處理。
- **服務供應商與檔案遷移** — Cherry Studio/Kelivo 匯入可選擇遷移關聯服務供應商、API Key 和檔案附件。
- **備份** — 透過本機目錄、WebDAV 或 S3 相容儲存進行備份與還原。
## 桌面體驗與安全
- **本機加密** — 應用狀態位於 ~/.boosapi/,使用者檔案位於 ~/Documents/boosapi/,API Key 使用 AES-256 和本機主金鑰保護。
- **桌面整合** — 支援系統匣、視窗置頂、全域快捷鍵、開機自啟、代理設定和自動更新檢查。
- **11 種界面語言** — 可在簡體中文、繁體中文、英語、日語、韓語、法語、德語、西班牙語、俄語、印地語和阿拉伯語之間切換。
+204
View File
@@ -0,0 +1,204 @@
# API 閘道
## 什麼是 API 閘道?
BoosApi 內建了一個本機 API 閘道伺服器,可以將您在 BoosApi 中設定的 AI 服務供應商統一暴露為標準 API 介面。其他工具和客戶端(如 Claude Code、Codex CLI、Cursor 等)可以透過這個閘道存取您的所有模型,無需為每個工具分別設定 API 金鑰。
閘道支援以下相容格式:
- **OpenAI 相容** — `/v1/chat/completions`
- **Claude 原生** — Anthropic API 格式
- **Gemini 原生** — Google AI API 格式
::: tip 使用場景
如果您已經在 BoosApi 中設定了多個服務供應商和金鑰,API 閘道可以讓其他開發工具直接復用這些設定,省去重複設定的麻煩。同時,閘道提供統一的用量統計和存取控制。
:::
## 快速上手
### 啟用閘道
1. 進入 **設定 → API 閘道**
2. 開啟閘道開關
3. 設定監聽參數:
- **連接埠** — 閘道監聽的連接埠號,預設 `8080`
- **主機** — 監聽位址,預設 `127.0.0.1`(僅本機存取)
::: warning 網路安全
如果將主機設定為 `0.0.0.0`,閘道將對所有網路介面開放。請確保您了解其安全風險,並配合 API 金鑰和防火牆使用。
:::
### 測試連通性
閘道啟動後,可以用 `curl` 快速驗證:
```bash
curl http://127.0.0.1:8080/v1/models \
-H "Authorization: Bearer your-gateway-api-key"
```
如果回傳了模型清單,說明閘道執行正常。
## API 金鑰管理
閘道使用獨立的 API 金鑰體系來控制存取權限。
### 產生新金鑰
1. 在 **API 閘道** 頁面中找到 **金鑰管理** 區域
2. 點擊 **產生金鑰**
3. 為金鑰新增描述備注(如「Claude Code 專用」、「團隊共享」)
4. 複製並妥善儲存產生的金鑰
::: danger 金鑰安全
金鑰僅在建立時完整顯示一次。請立即複製儲存,之後只能看到金鑰前綴。
:::
### 撤銷 / 停用金鑰
- **停用** — 暫時停用金鑰,可隨時重新啟用
- **刪除** — 永久撤銷金鑰,使用該金鑰的所有客戶端將立即失去存取權限
### 描述備注
為每個金鑰新增描述可以幫助您管理多個客戶端的存取。例如區分不同工具或團隊成員使用的金鑰。
## SSL/TLS
閘道支援 HTTPS 加密通訊,部分工具(如 Claude Code)要求使用 HTTPS 連線。
### 自動自簽憑證
啟用 SSL 後,BoosApi 會自動產生自簽憑證,無需手動操作。憑證檔案儲存在:
```
~/.boosapi/ssl/
├── cert.pem # 自簽憑證
└── key.pem # 私鑰(Unix 系統權限 0600)
```
### 自訂憑證
如果您有自己的 SSL 憑證(如 Let's Encrypt 簽發的憑證),可以在閘道設定中指定憑證和私鑰的路徑。
### 設定選項
| 選項 | 說明 |
|------|------|
| 啟用 SSL | 是否開啟 HTTPS |
| SSL 連接埠 | HTTPS 監聽連接埠 |
| 憑證路徑 | cert.pem 檔案路徑 |
| 私鑰路徑 | key.pem 檔案路徑 |
| 強制 SSL | 是否將所有 HTTP 請求重新導向到 HTTPS |
::: info 自簽憑證信任
使用自簽憑證時,客戶端可能會回報憑證不受信任的警告。大部分 CLI 工具可以透過設定環境變數來跳過憑證驗證(見下方設定範本)。
:::
## 用量統計
閘道提供詳細的用量統計面板,幫助您了解 API 的使用情況。
### 請求量面板
即時顯示閘道處理的請求總量、成功率和錯誤率。
### Token 用量
依不同維度查看 Token 消耗:
- **依金鑰** — 每個 API 金鑰使用了多少 Token
- **依服務供應商** — 每個後端服務供應商處理了多少請求和 Token
- **依日期** — 每日的 Token 使用趨勢
::: tip
透過用量統計,您可以了解哪個工具消耗最多資源,合理分配 API 配額。
:::
## 請求日誌
閘道記錄所有經過它的 API 請求,方便除錯和稽核。
每條日誌包含以下資訊:
| 欄位 | 說明 |
|------|------|
| 時間 | 請求的時間戳記 |
| 方法 | HTTP 方法(GET、POST 等) |
| 路徑 | 請求路徑 |
| 模型 | 請求使用的模型 |
| 服務供應商 | 轉發到的後端服務供應商 |
| 狀態碼 | HTTP 回應狀態碼 |
| Token | 輸入/輸出 Token 數量 |
| 延遲 | 請求處理耗時 |
支援依時間範圍、狀態碼、模型等條件篩選日誌。
## 設定範本
BoosApi 內建了常見開發工具的設定範本,幫助您快速接入。以下是一些常用工具的設定方式:
### Claude Code CLI
```bash
export ANTHROPIC_BASE_URL=https://127.0.0.1:8443
export ANTHROPIC_API_KEY=your-gateway-api-key
export NODE_TLS_REJECT_UNAUTHORIZED=0
claude
```
::: tip
`NODE_TLS_REJECT_UNAUTHORIZED=0` 用於跳過自簽憑證驗證。如果您使用了受信任的憑證,可以移除此設定。
:::
### OpenAI Codex CLI
```bash
export OPENAI_BASE_URL=http://127.0.0.1:8080/v1
export OPENAI_API_KEY=your-gateway-api-key
codex
```
### OpenCode
```bash
export OPENAI_BASE_URL=http://127.0.0.1:8080/v1
export OPENAI_API_KEY=your-gateway-api-key
opencode
```
### Gemini CLI
```bash
export GEMINI_API_KEY=your-gateway-api-key
export GEMINI_BASE_URL=http://127.0.0.1:8080
gemini
```
### 自訂客戶端
對於任何支援 OpenAI 相容 API 的客戶端,使用以下設定:
- **Base URL**: `http://127.0.0.1:8080/v1`
- **API Key**: 您的閘道 API 金鑰
- **模型**: 透過 `/v1/models` 介面查詢可用模型
## 接入外部工具
除 CLI 工具外,許多圖形化工具也支援自訂 API 端點。通用設定方式:
1. 在工具的設定中找到 API 設定或自訂端點選項
2. 將 Base URL 設定為 BoosApi 閘道位址
3. 將 API Key 設定為閘道金鑰
4. 儲存後即可使用 BoosApi 設定的所有模型
::: tip 統一管理的優勢
透過 API 閘道統一管理,您可以:
- 在 BoosApi 中集中管理所有服務供應商金鑰,其他工具只需一個閘道金鑰
- 在用量統計中查看所有工具的使用情況
- 利用多金鑰輪詢提高可靠性
:::
@@ -0,0 +1,212 @@
# 快速開始
本指南將幫助您在幾分鐘內完成 BoosApi 的安裝、設定和首次對話。
## 安裝
前往 [下載頁面](/zh-tw/download) 取得最新安裝套件,選擇與您系統相符的版本。
### macOS
BoosApi 提供兩種架構的 `.dmg` 安裝套件:
- **Apple Silicon**(M1/M2/M3/M4)— `BoosApi_x.x.x_aarch64.dmg`
- **Intel** — `BoosApi_x.x.x_x64.dmg`
下載後雙擊 `.dmg` 檔案,將 BoosApi 拖入「應用程式」資料夾即可。
::: warning macOS 安全提示
由於 BoosApi 尚未進行 Apple 公證簽名,首次開啟時系統可能彈出以下提示:
- **「BoosApi 已損毀,無法開啟」** 或 **「無法驗證開發者」**
請在終端機中執行以下指令後重新開啟:
```bash
xattr -cr /Applications/BoosApi.app
```
該指令會移除系統新增的隔離屬性,不會影響應用程式本身。
:::
### Windows
- **x64** — `BoosApi_x.x.x_x64-setup.exe`
- **ARM64** — `BoosApi_x.x.x_arm64-setup.exe`
雙擊安裝程式並依照精靈完成安裝。系統需求為 Windows 10(1803)或更高版本。
### Linux
根據您的發行版和架構選擇:
| 格式 | 架構 | 適用場景 |
|------|------|---------|
| `.deb` | amd64 / arm64 | Debian、Ubuntu 及其衍生版 |
| `.rpm` | x86_64 / aarch64 | Fedora、openSUSE 等 |
| `.AppImage` | x86_64 / aarch64 | 任意發行版,無需安裝 |
`.deb` 安裝範例:
```bash
sudo dpkg -i BoosApi_x.x.x_amd64.deb
```
`.AppImage` 需要先賦予執行權限:
```bash
chmod +x BoosApi_x.x.x_amd64.AppImage
./BoosApi_x.x.x_amd64.AppImage
```
## 首次設定
安裝完成後,依照以下步驟完成初始設定。
### 1. 進入設定
啟動 BoosApi 後,點擊左側邊欄底部的齒輪圖示進入 **設定** 頁面。
### 2. 新增服務供應商
進入 **設定 → 服務供應商**,點擊左下角的 **+** 按鈕新增一個服務供應商。以 OpenAI 為例:
1. 輸入服務供應商名稱,如 `OpenAI`
2. 選擇服務供應商類型為 **OpenAI**
3. 填入您的 **API 金鑰**
4. **Base URL** 保持預設 `https://api.openai.com`,若使用第三方中繼服務則填寫其位址
::: tip 取得 API 金鑰
前往 [OpenAI API Keys](https://platform.openai.com/api-keys) 頁面建立金鑰。其他服務供應商的金鑰取得方式請參考各自官方文件。
:::
### 3. 取得模型
服務供應商新增完成後,點擊 **取得模型** 按鈕,BoosApi 會自動從 API 拉取可用模型清單。您也可以在模型 ID 輸入框中手動新增模型。
### 4. 設定預設模型
進入 **設定 → 預設模型**,選擇您最常用的模型作為預設助手模型和話題命名模型。新建對話時將自動使用預設模型。
## 開始第一次對話
### 新建對話
點擊左側邊欄頂部的 **新建對話** 按鈕,或使用快捷鍵 `Cmd/Ctrl+N`。
### 選擇模型
在對話頂部的模型選擇器中選取您想使用的模型。如果您已設定了預設模型,會自動填充。
### 傳送訊息
在底部輸入框中輸入您的問題,按 `Enter` 傳送。BoosApi 使用串流輸出,您會看到模型的回答逐字呈現。
::: info 關於 Thinking 區塊
部分模型(如 Claude、DeepSeek R1)支援輸出推理過程。當模型包含 thinking 區塊時,BoosApi 會將其折疊顯示,點擊即可展開查看完整推理鏈。
:::
## 核心概念
### 對話分支
BoosApi 支援對話分支功能。當您在某條訊息基礎上重新生成或編輯提問時,系統會建立一個新的分支而非覆蓋原內容。您可以隨時在不同分支之間切換,比較不同的對話走向。
### 訊息版本
每條訊息可以擁有多個版本。重新生成助手回覆時,新版本會自動新增到同一訊息位置。透過訊息旁的左右箭頭可以在版本間快速切換。
### 上下文掛載
在對話中,您可以透過附件功能掛載額外的上下文資訊:
- **檔案** — 上傳圖片或文件作為對話上下文
- **搜尋** — 關聯本機知識庫搜尋結果
- **工具** — 啟用 MCP 工具讓模型呼叫外部能力
## 快捷鍵
BoosApi 內建了一套常用快捷鍵,提升操作效率:
| 快捷鍵 | 功能 |
|-------|------|
| `CmdOrCtrl+Shift+A` | 顯示/隱藏目前視窗 |
| `CmdOrCtrl+Shift+Z` | 顯示/隱藏所有視窗 |
| `Cmd/Ctrl+N` | 新建對話 |
| `Cmd/Ctrl+,` | 開啟設定 |
| `Cmd/Ctrl+F` | 搜尋對話 |
::: tip 自訂快捷鍵
以上快捷鍵均可在 **設定 → 快捷鍵** 中自訂修改,包括全域快捷鍵和應用程式內快捷鍵。
:::
## 桌面設定
在 **設定** 中可以調整各項桌面偏好:
### 外觀
- **主題** — 支援深色、淺色和跟隨系統三種模式
- **主題色** — 從 12 種預設色中選擇,也支援自訂顏色
- **字型** — 可調整字型大小(12–20px)、字重和字型家族
### 語言
支援繁體中文、簡體中文和英文介面切換,在 **設定 → 一般** 中修改。
### 系統行為
- **系統托盤** — 關閉視窗後保持在系統托盤執行
- **開機自啟** — 設定系統登入時自動啟動 BoosApi
- **視窗置頂** — 將 BoosApi 視窗始終置於最前
### 代理設定
如果您需要透過代理存取 API,在 **設定 → 代理** 中設定:
- **代理類型** — 支援 HTTP 和 SOCKS5
- **代理位址** — 代理伺服器的 IP 或網域名稱
- **代理連接埠** — 預設為 7890
設定完成後可以點擊 **測試** 按鈕驗證連通性,會顯示延遲結果。
## 資料與備份
### 資料目錄
BoosApi 使用兩個目錄分別儲存不同類型的資料:
| 目錄 | 用途 |
|------|------|
| `~/.boosapi/` | 應用狀態:資料庫、加密金鑰、向量資料庫、SSL 憑證 |
| `~/Documents/boosapi/` | 使用者檔案:圖片、文件附件、備份 |
### 自動備份
在 **設定 → 備份** 中開啟自動備份。支援以下備份目標:
- **本機** — 預設儲存到 `~/Documents/boosapi/backups/`
- **WebDAV** — 同步到支援 WebDAV 的網路磁碟機
可設定備份間隔(小時)和保留的最大備份數量。
### 手動備份與還原
隨時可以透過 **設定 → 備份** 手動觸發完整備份。還原時選擇備份檔案即可還原所有資料。
### 對話匯出
在對話頁面中,可以將目前對話匯出為多種格式:
- **PNG** — 長圖截圖,適合分享
- **Markdown** — 結構化文字,方便二次編輯
- **純文字** — 簡潔格式
- **JSON** — 包含完整中繼資料,方便程式處理
## 下一步
基礎設定完成後,您可以繼續探索 BoosApi 的進階功能:
- [設定服務供應商](./providers) — 多服務供應商、多金鑰、自訂端點
- [MCP 伺服器](./mcp) — 連接外部工具擴展 AI 能力
- [API 閘道](./gateway) — 將 BoosApi 作為 API 代理伺服器
+199
View File
@@ -0,0 +1,199 @@
# MCP 伺服器
## 什麼是 MCP?
[Model Context Protocol(MCP)](https://modelcontextprotocol.io/)是一種開放協定,讓 AI 模型能夠與外部工具和資料來源互動。透過 MCP,模型可以在對話中呼叫檔案操作、網頁擷取、資料庫查詢等各種工具,大幅擴展 AI 的實際能力。
BoosApi 內建了 MCP 客戶端,您可以連接各種 MCP 伺服器來為 AI 對話增加工具呼叫能力。
## 傳輸協定
BoosApi 支援三種 MCP 傳輸協定,適用於不同的部署場景:
| 協定 | 連線方式 | 適用場景 | 設定參數 |
|------|---------|---------|---------|
| **Stdio** | 本機子程序 | 透過 `npx`、`uvx`、自訂指令啟動的本機工具 | `command` + `args` |
| **SSE** | Server-Sent Events | 遠端託管的 MCP 伺服器 | `url` |
| **StreamableHTTP** | HTTP 串流傳輸 | 遠端 HTTP 伺服器,支援雙向串流 | `url` |
::: info Stdio vs 遠端
大部分 MCP 伺服器以 Stdio 模式執行——BoosApi 在本機啟動一個程序並透過標準輸入/輸出通訊。如果您連接的是遠端部署的伺服器,則使用 SSE 或 StreamableHTTP 協定。
:::
## 新增 MCP 伺服器
### 表單建立
1. 進入 **設定 → MCP 伺服器**
2. 點擊 **新增 MCP 伺服器**
3. 填寫基本資訊:
- **名稱** — 為伺服器取一個易識別的名稱
- **傳輸協定** — 選擇 Stdio、SSE 或 StreamableHTTP
4. 根據所選協定填寫相應設定:
- **Stdio**:填寫啟動指令(如 `npx`、`uvx`)和參數
- **SSE / StreamableHTTP**:填寫伺服器 URL
5. 儲存後 BoosApi 會自動連接並取得可用工具清單
### JSON 匯入
如果您有現成的 MCP 設定(如從其他工具匯出),可以直接貼上 JSON 快速匯入。BoosApi 支援標準的 `mcpServers` 設定格式。
#### Stdio 協定格式
```json
{
"mcpServers": {
"my-tool": {
"command": "npx",
"args": ["-y", "@some/mcp-server"],
"env": {
"API_KEY": "your-key"
}
}
}
}
```
#### SSE 協定格式
```json
{
"mcpServers": {
"remote-server": {
"type": "sse",
"url": "https://example.com/sse"
}
}
}
```
#### StreamableHTTP 協定格式
```json
{
"mcpServers": {
"http-server": {
"type": "streamablehttp",
"url": "https://example.com/mcp"
}
}
}
```
::: tip 批次匯入
您可以在一個 JSON 中包含多個伺服器,BoosApi 會一次性全部匯入。
:::
## 設定範例
以下是一些常用 MCP 伺服器的設定範例。
### 網頁擷取 — mcp-server-fetch
使用 `uvx` 啟動網頁擷取工具,讓 AI 能夠讀取網頁內容:
```json
{
"mcpServers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
}
}
}
```
### 檔案系統操作 — filesystem server
使用 `npx` 啟動檔案系統伺服器,允許 AI 讀寫指定目錄的檔案:
```json
{
"mcpServers": {
"filesystem": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"/Users/您的使用者名稱/Documents"
]
}
}
}
```
::: warning 安全提示
檔案系統伺服器會授予 AI 對指定目錄的讀寫權限。請只暴露必要的目錄路徑,避免將根目錄或敏感目錄暴露給模型。
:::
### 遠端 SSE 伺服器
連接遠端部署的 MCP 伺服器:
```json
{
"mcpServers": {
"remote-tools": {
"type": "sse",
"url": "https://mcp.example.com/sse"
}
}
}
```
### 自訂 Stdio 伺服器(帶環境變數)
執行自訂的 MCP 伺服器,透過環境變數傳遞設定:
```json
{
"mcpServers": {
"custom-tool": {
"command": "python",
"args": ["/path/to/your/server.py"],
"env": {
"DATABASE_URL": "postgres://localhost:5432/mydb",
"API_TOKEN": "your-token"
}
}
}
}
```
## 內建工具
BoosApi 開箱即用地提供了一些內建 MCP 工具伺服器,無需額外安裝:
### @boosapi/fetch — 網頁擷取
| 工具 | 說明 |
|------|------|
| `fetch_url` | 擷取指定 URL 的頁面內容,提取文字 |
| `fetch_markdown` | 擷取指定 URL 並轉換為 Markdown 格式 |
### @boosapi/search-file — 檔案操作
| 工具 | 說明 |
|------|------|
| `read_file` | 讀取指定路徑的檔案內容 |
| `list_directory` | 列出指定目錄下的檔案和資料夾 |
| `search_files` | 依模式搜尋相符的檔案 |
::: tip
內建工具伺服器在 MCP 伺服器清單中預設顯示,可以直接在對話中啟用使用,無需任何額外設定。
:::
## 工具循環上限
在 設定 -> 對話 中,MCP 工具呼叫最大輪次 用於限制單次回覆中模型連續呼叫工具的輪數。較低數值可減少耗時和成本,較高數值適合更長的自動化工具流程。
## 工具執行面板
當模型在對話中呼叫 MCP 工具時,BoosApi 會在訊息中顯示工具執行面板,其中包含:
- **工具名稱** — 被呼叫的工具和所屬伺服器
- **輸入參數** — 模型傳給工具的參數
- **執行狀態** — 等待確認、執行中、已完成或失敗
- **回傳結果** — 工具執行後回傳的資料
點擊面板可以展開查看完整的輸入和輸出資訊,方便除錯和了解 AI 的工具使用行為。
@@ -0,0 +1,243 @@
# 設定服務供應商
BoosApi 支援接入多種 AI 服務供應商,您可以同時設定多個服務供應商並在對話中自由切換。
## 支援的服務供應商
BoosApi 內建以下服務供應商類型,並支援任何相容 OpenAI API 格式的自訂端點:
| 服務供應商 | 代表模型 | 說明 |
|-----------|---------|------|
| **OpenAI** | GPT-4o、GPT-4、o3、o4-mini | 最廣泛支援的 API 格式 |
| **Anthropic** | Claude 4 Sonnet/Opus、Claude 3.5 Sonnet | 原生 Claude API |
| **Google** | Gemini 2.5 Pro/Flash、Gemini 2.0 | Google AI Studio 或 Vertex |
| **DeepSeek** | DeepSeek-V3、DeepSeek-R1 | 高性價比推理模型 |
| **阿里雲通義千問** | Qwen-Max、Qwen-Plus、Qwen-Turbo | 相容 OpenAI 格式 |
| **智譜 GLM** | GLM-4、GLM-4-Flash | 國產大模型 |
| **xAI** | Grok-3、Grok-3-mini | xAI 出品 |
| **OpenAI 相容** | 任意模型 | 適配所有相容 OpenAI 格式的第三方服務 |
## 新增服務供應商
### 基本步驟
1. 進入 **設定 → 服務供應商**
2. 點擊左下角的 **+** 按鈕
3. 填寫以下資訊:
- **名稱** — 自訂名稱,用於在介面中區分不同服務供應商
- **類型** — 選擇對應的服務供應商類型(如 OpenAI、Anthropic 等)
- **圖示** — 可選,為服務供應商選擇一個顯示圖示
4. 點擊確認建立
### 設定 API
建立服務供應商後,需要填寫 API 連線資訊:
#### API 金鑰
填入從服務供應商處取得的 API 金鑰。例如 OpenAI 的金鑰格式為 `sk-...`。
::: tip 金鑰安全
BoosApi 使用 AES-256 加密儲存所有 API 金鑰,金鑰資料儲存在本機 `~/.boosapi/boosapi.db` 中,不會上傳到任何外部伺服器。
:::
#### Base URL
API 的基礎位址。各服務供應商的官方位址:
| 服務供應商 | 官方 Base URL |
|-----------|--------------|
| OpenAI | `https://api.openai.com` |
| Anthropic | `https://api.anthropic.com` |
| Google | `https://generativelanguage.googleapis.com` |
| DeepSeek | `https://api.deepseek.com` |
| 阿里雲通義 | `https://dashscope.aliyuncs.com/compatible-mode` |
| 智譜 GLM | `https://open.bigmodel.cn` |
| xAI | `https://api.x.ai` |
如果您使用第三方中繼服務或自建代理,將 Base URL 替換為中繼位址即可。
#### API 路徑
API 請求的路徑部分,預設為 `/v1/chat/completions`。一般情況下無需修改,除非服務供應商使用了非標準路徑。
## 從網頁連結匯入服務供應商
服務供應商官網、中繼服務後台、私有模型平台或本機閘道頁面,可以提供一個 **在 BoosApi 中開啟** 的連結。使用者點擊後,瀏覽器會喚起 BoosApi 桌面端,BoosApi 會進入 **設定 → 服務供應商**,顯示確認視窗,並在使用者確認後匯入服務供應商設定。
### 使用流程
1. 安裝並開啟支援服務供應商連結匯入的 BoosApi 版本。
2. 在瀏覽器中點擊服務頁面提供的 **在 BoosApi 中開啟** 連結。
3. 在 BoosApi 確認視窗中檢查服務供應商名稱、Base URL、服務供應商類型和 API Key 前綴。
4. 確認後,BoosApi 會按 **Base URL + 類型** 重用既有服務供應商;如果不存在則建立新服務供應商,並在金鑰不存在時追加 API Key。
BoosApi 不會自動驗證 API Key,也不會自動同步模型清單。匯入後可點擊 **取得模型**,或手動新增模型 ID。
### 連結格式
```text
boosapi://providers?name=<name>&baseurl=<base-url>&apikey=<api-key>&type=<provider-type>
```
範例:
```text
boosapi://providers?name=OpenAI&baseurl=https%3A%2F%2Fapi.openai.com&apikey=sk-xxx&type=openai
```
### 參數說明
| 參數 | 必填 | 說明 |
|------|------|------|
| `name` | 是 | 服務供應商顯示名稱,例如 `OpenAI`、`我的中繼服務` |
| `baseurl` | 是 | 服務供應商 Base URL,需 URL 編碼;僅允許 `http` / `https`,不允許 query 或 hash |
| `apikey` | 是 | 要儲存到 BoosApi 的 API Key;確認視窗只顯示前綴,不顯示完整金鑰 |
| `type` | 是 | 服務供應商類型;可選值:`openai`、`openai_responses`、`anthropic`、`gemini`、`custom` |
`baseurl` 支援 BoosApi 既有的強制後綴語義,例如 `https://example.com!`。透過連結匯入時不會設定 `api_path`,BoosApi 會繼續按所選服務供應商類型使用預設路徑邏輯。
### 官網/後台頁面如何設定連結
對所有動態值使用 `encodeURIComponent` 或 `URLSearchParams` 進行編碼:
```html
<a id="open-boosapi" href="#">在 BoosApi 中開啟</a>
<script>
const provider = {
name: '我的中繼服務',
baseurl: 'https://api.example.com',
apikey: 'sk-user-key',
type: 'openai',
};
const params = new URLSearchParams({
name: provider.name,
baseurl: provider.baseurl,
apikey: provider.apikey,
type: provider.type,
});
document.getElementById('open-boosapi').href = `boosapi://providers?${params.toString()}`;
</script>
```
如果您的服務支援線上產生 API Key,建議只在使用者登入後,且明確選擇或建立金鑰後再產生此連結。
::: warning 安全提醒
URL 中攜帶 API Key 可能被瀏覽器歷史、日誌、瀏覽器擴充套件或統計腳本記錄。不要把真實金鑰寫在公開頁面、靜態 HTML 或第三方跳轉連結中;建議在使用者私有後台頁面中按需產生,並讓使用者主動點擊。
:::
::: tip 測試提示
`boosapi://` 是桌面應用註冊到系統的自訂協定。僅執行官網或 Vite 開發服務不會註冊協定;如果點擊後沒有喚起 BoosApi,請先安裝或重新建置最新 BoosApi 桌面端。
:::
## 從 CC Switch 匯入
在 設定 -> 服務供應商 中,BoosApi 可以掃描 CC Switch 的服務供應商設定。你可以逐條檢查候選項,選擇可匯入記錄後,把服務供應商、Base URL、API Key 和模型列表匯入 BoosApi。OAuth-only 或沒有可復用金鑰的記錄會被跳過並顯示原因。
## 進階模型請求體
每個模型都可以設定 extra_body,這是一個 JSON 物件,會平鋪追加到 OpenAI 相容 Chat Completions 請求體中。它適合 enable_thinking 等廠商私有參數。BoosApi 會校驗 JSON,並阻止覆蓋 model、messages、stream、tools 和基礎採樣欄位。
## 多金鑰輪詢
BoosApi 支援為同一個服務供應商設定多個 API 金鑰,實現自動輪換:
### 新增多個金鑰
在服務供應商設定頁面的 API 金鑰區域,可以新增多個金鑰。所有金鑰共享同一個 Base URL 和設定。
### 自動輪換機制
當設定了多個金鑰時,BoosApi 會在每次請求時自動輪換使用不同的金鑰。
### 限流分散
多金鑰輪詢的一個重要用途是分散 API 限流。每個金鑰有獨立的速率配額,使用多個金鑰可以有效提高整體吞吐量,降低單個金鑰觸發限流的概率。
::: tip 適用場景
如果您有團隊共享的多個 API 金鑰,或者單個金鑰的速率限制無法滿足需求,多金鑰輪詢是一個簡單高效的解決方案。
:::
## 模型管理
### 遠端拉取模型清單
點擊 **取得模型** 按鈕,BoosApi 會呼叫服務供應商的模型清單 API,自動拉取目前可用的全部模型。拉取後的模型會顯示在清單中供您選擇。
### 手動新增模型
如果服務供應商的模型清單 API 不完整或您需要新增特定模型,可以手動輸入模型 ID 進行新增。例如:
- `gpt-4o`
- `claude-sonnet-4-20250514`
- `gemini-2.5-pro`
### 模型參數
每個模型可以獨立設定以下預設參數:
| 參數 | 說明 | 典型範圍 |
|-----|------|---------|
| **溫度 (Temperature)** | 控制輸出的隨機性,值越高越有創意 | 0 – 2 |
| **最大 Token (Max Tokens)** | 限制單次回覆的最大長度 | 1 – 模型上限 |
| **Top-P** | 核採樣概率閾值,與溫度配合使用 | 0 – 1 |
| **頻率懲罰 (Frequency Penalty)** | 降低已出現詞彙的重複概率 | -2 – 2 |
| **存在懲罰 (Presence Penalty)** | 鼓勵模型討論新話題 | -2 – 2 |
::: info 參數建議
對於日常對話,保持預設參數即可。如果需要更有創意的輸出,可以適當提高溫度;需要精確回答時,降低溫度到 0–0.3。
:::
## 自訂/本機端點
BoosApi 支援連接任何相容 OpenAI API 格式的服務,以下是常見場景的設定範例。
### Ollama
[Ollama](https://ollama.ai/) 可以在本機執行開源大模型。設定方法:
1. 新增服務供應商,類型選擇 **OpenAI**
2. Base URL 填寫 `http://localhost:11434`
3. API 金鑰留空或填寫任意值
4. 點擊 **取得模型** 拉取本機已下載的模型
::: warning 注意
請確保 Ollama 服務已啟動。部分 Ollama 版本可能需要設定 `OLLAMA_ORIGINS=*` 環境變數以允許跨域請求。
:::
### vLLM / TGI
如果您使用 vLLM 或 Text Generation Inference 部署了自己的模型:
1. 新增服務供應商,類型選擇 **OpenAI**
2. Base URL 填寫您的部署位址,如 `http://your-server:8000`
3. API 金鑰根據您的服務設定填寫
4. 手動新增您部署的模型 ID
### API 中繼服務
很多第三方提供 OpenAI 相容的 API 中繼服務,設定方法相同:
1. 新增服務供應商,類型選擇 **OpenAI**
2. Base URL 填寫中繼服務提供的位址
3. API 金鑰填寫中繼服務提供的金鑰
4. 取得或手動新增模型
## 預設模型設定
BoosApi 支援為不同用途設定預設模型,在 **設定 → 預設模型** 中設定:
### 全域預設助手模型
新建對話時自動使用的模型。建議選擇您最常用的模型,例如 `gpt-4o` 或 `claude-sonnet-4-20250514`。
### 預設話題命名模型
用於自動為對話生成標題的模型。這個模型不需要很強大,選擇一個回應快且便宜的模型即可,如 `gpt-4o-mini` 或 `gemini-2.0-flash`。
::: tip
預設模型設定是可選的。如果不設定,每次新建對話時需要手動選擇模型。
:::
+57
View File
@@ -0,0 +1,57 @@
---
layout: home
title: "BoosApi — 開源 AI 桌面客戶端與閘道"
titleTemplate: false
head:
- - meta
- name: description
content: "BoosApi 是免費開源的 AI 桌面客戶端,支援多模型對話、Agent、MCP、ChatGPT/Cherry Studio/Kelivo 匯入、本機知識庫、S3/WebDAV 備份和內建 AI 閘道。"
hero:
name: BoosApi
text: "你的 AI 桌面工作台"
tagline: "多模型對話、Agent、MCP 工具、API 閘道、資料匯入、知識庫和備份整合在一個本機優先客戶端裡"
image:
src: /logo.png
alt: BoosApi
actions:
- theme: brand
text: "快速開始"
link: /zh-tw/guide/getting-started
- theme: alt
text: "下載"
link: /zh-tw/download
- theme: alt
text: GitHub
link: https://github.com/BoosApi-Desktop/BoosApi
features:
- icon: robot
title: "多模型對話"
details: "OpenAI、Claude、Gemini、DeepSeek、Qwen 和相容 API,支援金鑰輪詢、分支、壓縮和多模型回答。"
- icon: api
title: "服務供應商快速設定"
details: "boosapi:// 連結、CC Switch 匯入、自訂請求頭、代理、OpenAI Responses 和模型 extra_body。"
- icon: thunderbolt
title: "AI Agent"
details: "檔案編輯、命令執行和程式碼分析,帶權限分級、工作目錄沙箱、審批 UI 和成本統計。"
- icon: edit
title: "富內容渲染"
details: "Markdown、LaTeX、Mermaid、D2、Monaco 程式碼區塊、HTML 片段和 Artifact 預覽。"
- icon: search
title: "搜尋與 RAG"
details: "帶引用的網路搜尋、查詢生成、本機 sqlite-vec 知識庫、重排設定和檢索回饋。"
- icon: cloud-server
title: "API 閘道"
details: "本機 OpenAI 相容、OpenAI Responses、Claude 和 Gemini 介面,服務 Claude Code、Codex、OpenCode 等工具。"
- icon: book
title: "資料匯入"
details: "匯入 ChatGPT 官方匯出、Cherry Studio 與 Kelivo 備份,處理重複並可遷移服務供應商。"
- icon: lock
title: "備份與安全"
details: "AES-256 本機加密、雙目錄資料布局、本機/WebDAV/S3 備份和還原流程。"
- icon: desktop
title: "桌面體驗"
details: "11 種界面語言、系統匣、置頂、全域快捷鍵、開機自啟、代理和自動更新檢查。"
---