feat: docs update

2026-07-19 21:07:28 +08:00 · 2026-02-27 16:03:47 +08:00
parent d891312032
commit 6db22827f2
97 changed files with 2801 additions and 1354 deletions
--- a/docs/models/claude.mdx
+++ b/docs/models/claude.mdx
@@ -0,0 +1,17 @@
+---
+title: Claude
+description: Claude 模型配置
+---
+
+```json
+{
+  "model": "claude-sonnet-4-6",
+  "claude_api_key": "YOUR_API_KEY"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 支持 `claude-sonnet-4-6`、`claude-opus-4-6`、`claude-sonnet-4-5`、`claude-sonnet-4-0`、`claude-3-5-sonnet-latest` 等，参考 [官方模型](https://docs.anthropic.com/en/docs/about-claude/models/overview) |
+| `claude_api_key` | 在 [Claude 控制台](https://console.anthropic.com/settings/keys) 创建 |
+| `claude_api_base` | 可选，默认为 `https://api.anthropic.com/v1`，修改可接入第三方代理 |
--- a/docs/models/deepseek.mdx
+++ b/docs/models/deepseek.mdx
@@ -0,0 +1,22 @@
+---
+title: DeepSeek
+description: DeepSeek 模型配置
+---
+
+通过 OpenAI 兼容方式接入：
+
+```json
+{
+  "model": "deepseek-chat",
+  "open_ai_api_key": "YOUR_API_KEY",
+  "open_ai_api_base": "https://api.deepseek.com/v1",
+  "bot_type": "chatGPT"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | `deepseek-chat`（DeepSeek-V3）、`deepseek-reasoner`（DeepSeek-R1） |
+| `bot_type` | 固定为 `chatGPT`（OpenAI 兼容方式） |
+| `open_ai_api_key` | 在 [DeepSeek 平台](https://platform.deepseek.com/api_keys) 创建 |
+| `open_ai_api_base` | DeepSeek 平台 BASE URL |
--- a/docs/models/doubao.mdx
+++ b/docs/models/doubao.mdx
@@ -0,0 +1,19 @@
+---
+title: 豆包 Doubao
+description: 豆包 (火山方舟) 模型配置
+---
+
+# 豆包 (Doubao)
+
+```json
+{
+  "model": "doubao-seed-2-0-code-preview-260215",
+  "ark_api_key": "YOUR_API_KEY"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 可填 `doubao-seed-2-0-code-preview-260215`、`doubao-seed-2-0-pro-260215`、`doubao-seed-2-0-lite-260215` 等 |
+| `ark_api_key` | 在 [火山方舟控制台](https://console.volcengine.com/ark/region:ark+cn-beijing/apikey) 创建 |
+| `ark_base_url` | 可选，默认为 `https://ark.cn-beijing.volces.com/api/v3` |
--- a/docs/models/gemini.mdx
+++ b/docs/models/gemini.mdx
@@ -0,0 +1,16 @@
+---
+title: Gemini
+description: Google Gemini 模型配置
+---
+
+```json
+{
+  "model": "gemini-3.1-pro-preview",
+  "gemini_api_key": "YOUR_API_KEY"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 支持 `gemini-3.1-pro-preview`、`gemini-3-flash-preview`、`gemini-3-pro-preview`、`gemini-2.5-pro`、`gemini-2.0-flash` 等，参考 [官方文档](https://ai.google.dev/gemini-api/docs/models) |
+| `gemini_api_key` | 在 [Google AI Studio](https://aistudio.google.com/app/apikey) 创建 |
--- a/docs/models/glm.mdx
+++ b/docs/models/glm.mdx
@@ -0,0 +1,29 @@
+---
+title: 智谱 GLM
+description: 智谱AI GLM 模型配置
+---
+
+# 智谱AI (GLM)
+
+```json
+{
+  "model": "glm-5",
+  "zhipu_ai_api_key": "YOUR_API_KEY"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 可填 `glm-5`、`glm-4.7`、`glm-4-plus`、`glm-4-flash`、`glm-4-air` 等，参考 [模型编码](https://bigmodel.cn/dev/api/normal-model/glm-4) |
+| `zhipu_ai_api_key` | 在 [智谱AI 控制台](https://www.bigmodel.cn/usercenter/proj-mgmt/apikeys) 创建 |
+
+也支持 OpenAI 兼容方式接入：
+
+```json
+{
+  "bot_type": "chatGPT",
+  "model": "glm-5",
+  "open_ai_api_base": "https://open.bigmodel.cn/api/paas/v4",
+  "open_ai_api_key": "YOUR_API_KEY"
+}
+```
--- a/docs/models/index.mdx
+++ b/docs/models/index.mdx
@@ -0,0 +1,55 @@
+---
+title: 模型概览
+description: CowAgent 支持的模型及推荐选择
+---
+
+CowAgent 支持国内外主流厂商的大语言模型，模型接口实现在项目的 `models/` 目录下。
+
+<Note>
+  Agent 模式下推荐使用以下模型，可根据效果及成本综合选择：MiniMax-M2.5、glm-5、kimi-k2.5、qwen3.5-plus、claude-sonnet-4-6、gemini-3.1-pro-preview
+</Note>
+
+## 配置方式
+
+根据所选模型，在 `config.json` 中填写对应的模型名称和 API Key 即可。每个模型也支持 OpenAI 兼容方式接入，将 `bot_type` 设为 `chatGPT`，配置 `open_ai_api_base` 和 `open_ai_api_key`。
+
+同时支持使用 [LinkAI](https://link-ai.tech) 平台接口，可灵活切换多种模型并支持知识库、工作流等 Agent 能力。
+
+## 支持的模型
+
+<CardGroup cols={2}>
+  <Card title="MiniMax" href="/models/minimax">
+    MiniMax-M2.5 等系列模型
+  </Card>
+  <Card title="智谱 GLM" href="/models/glm">
+    glm-5、glm-4.7 等系列模型
+  </Card>
+  <Card title="通义千问 Qwen" href="/models/qwen">
+    qwen3.5-plus、qwen3-max 等
+  </Card>
+  <Card title="Kimi" href="/models/kimi">
+    kimi-k2.5、kimi-k2 等
+  </Card>
+  <Card title="豆包 Doubao" href="/models/doubao">
+    doubao-seed 系列模型
+  </Card>
+  <Card title="Claude" href="/models/claude">
+    claude-sonnet-4-6 等
+  </Card>
+  <Card title="Gemini" href="/models/gemini">
+    gemini-3.1-pro-preview 等
+  </Card>
+  <Card title="OpenAI" href="/models/openai">
+    gpt-4.1、o 系列等
+  </Card>
+  <Card title="DeepSeek" href="/models/deepseek">
+    deepseek-chat、deepseek-reasoner
+  </Card>
+  <Card title="LinkAI" href="/models/linkai">
+    多模型统一接口 + 知识库
+  </Card>
+</CardGroup>
+
+<Tip>
+  全部模型名称可参考项目 [`common/const.py`](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/common/const.py) 文件。
+</Tip>
--- a/docs/models/kimi.mdx
+++ b/docs/models/kimi.mdx
@@ -0,0 +1,29 @@
+---
+title: Kimi
+description: Kimi (Moonshot) 模型配置
+---
+
+# Kimi (Moonshot)
+
+```json
+{
+  "model": "kimi-k2.5",
+  "moonshot_api_key": "YOUR_API_KEY"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 可填 `kimi-k2.5`、`kimi-k2`、`moonshot-v1-8k`、`moonshot-v1-32k`、`moonshot-v1-128k` |
+| `moonshot_api_key` | 在 [Moonshot 控制台](https://platform.moonshot.cn/console/api-keys) 创建 |
+
+也支持 OpenAI 兼容方式接入：
+
+```json
+{
+  "bot_type": "chatGPT",
+  "model": "kimi-k2.5",
+  "open_ai_api_base": "https://api.moonshot.cn/v1",
+  "open_ai_api_key": "YOUR_API_KEY"
+}
+```
--- a/docs/models/linkai.mdx
+++ b/docs/models/linkai.mdx
@@ -0,0 +1,23 @@
+---
+title: LinkAI
+description: 通过 LinkAI 平台统一接入多种模型
+---
+
+通过 [LinkAI](https://link-ai.tech) 平台可灵活切换 OpenAI、Claude、Gemini、DeepSeek、Qwen、Kimi 等多种模型，并支持知识库、工作流、插件等 Agent 能力。
+
+```json
+{
+  "use_linkai": true,
+  "linkai_api_key": "YOUR_API_KEY",
+  "linkai_app_code": "YOUR_APP_CODE"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `use_linkai` | 设为 `true` 启用 LinkAI 接口 |
+| `linkai_api_key` | 在 [控制台](https://link-ai.tech/console/interface) 创建 |
+| `linkai_app_code` | LinkAI 智能体（应用或工作流）的 code，选填 |
+| `model` | 留空则使用智能体默认模型，可在平台中灵活切换，[模型列表](https://link-ai.tech/console/models) 中的全部模型均可使用 |
+
+参考 [接口文档](https://docs.link-ai.tech/platform/api) 了解更多。
--- a/docs/models/minimax.mdx
+++ b/docs/models/minimax.mdx
@@ -0,0 +1,27 @@
+---
+title: MiniMax
+description: MiniMax 模型配置
+---
+
+```json
+{
+  "model": "MiniMax-M2.5",
+  "minimax_api_key": "YOUR_API_KEY"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 可填 `MiniMax-M2.5`、`MiniMax-M2.1`、`MiniMax-M2.1-lightning`、`MiniMax-M2` 等 |
+| `minimax_api_key` | 在 [MiniMax 控制台](https://platform.minimaxi.com/user-center/basic-information/interface-key) 创建 |
+
+也支持 OpenAI 兼容方式接入：
+
+```json
+{
+  "bot_type": "chatGPT",
+  "model": "MiniMax-M2.5",
+  "open_ai_api_base": "https://api.minimaxi.com/v1",
+  "open_ai_api_key": "YOUR_API_KEY"
+}
+```
--- a/docs/models/openai.mdx
+++ b/docs/models/openai.mdx
@@ -0,0 +1,19 @@
+---
+title: OpenAI
+description: OpenAI 模型配置
+---
+
+```json
+{
+  "model": "gpt-4.1-mini",
+  "open_ai_api_key": "YOUR_API_KEY",
+  "open_ai_api_base": "https://api.openai.com/v1"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 与 OpenAI 接口的 [model 参数](https://platform.openai.com/docs/models) 一致，支持 o 系列、gpt-5.2、gpt-5.1、gpt-4.1 等 |
+| `open_ai_api_key` | 在 [OpenAI 平台](https://platform.openai.com/api-keys) 创建 |
+| `open_ai_api_base` | 可选，修改可接入第三方代理接口 |
+| `bot_type` | 使用 OpenAI 官方模型时无需填写。当通过代理接口使用 Claude 等非 OpenAI 模型时，设为 `chatGPT` |
--- a/docs/models/qwen.mdx
+++ b/docs/models/qwen.mdx
@@ -0,0 +1,29 @@
+---
+title: 通义千问 Qwen
+description: 通义千问模型配置
+---
+
+# 通义千问 (Qwen)
+
+```json
+{
+  "model": "qwen3.5-plus",
+  "dashscope_api_key": "YOUR_API_KEY"
+}
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `model` | 可填 `qwen3.5-plus`、`qwen3-max`、`qwen-max`、`qwen-plus`、`qwen-turbo`、`qwq-plus` 等 |
+| `dashscope_api_key` | 在 [百炼控制台](https://bailian.console.aliyun.com/?tab=model#/api-key) 创建，参考 [官方文档](https://bailian.console.aliyun.com/?tab=api#/api) |
+
+也支持 OpenAI 兼容方式接入：
+
+```json
+{
+  "bot_type": "chatGPT",
+  "model": "qwen3.5-plus",
+  "open_ai_api_base": "https://dashscope.aliyuncs.com/compatible-mode/v1",
+  "open_ai_api_key": "YOUR_API_KEY"
+}
+```