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/en/models/claude.mdx
+++ b/docs/en/models/claude.mdx
@@ -0,0 +1,17 @@
+---
+title: Claude
+description: Claude model configuration
+---
+
+```json
+{
+  "model": "claude-sonnet-4-6",
+  "claude_api_key": "YOUR_API_KEY"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Options include `claude-sonnet-4-6`, `claude-opus-4-6`, `claude-sonnet-4-5`, `claude-sonnet-4-0`, `claude-3-5-sonnet-latest`, etc. See [official models](https://docs.anthropic.com/en/docs/about-claude/models/overview) |
+| `claude_api_key` | Create at [Claude Console](https://console.anthropic.com/settings/keys) |
+| `claude_api_base` | Optional. Defaults to `https://api.anthropic.com/v1`. Change to use third-party proxy |
--- a/docs/en/models/deepseek.mdx
+++ b/docs/en/models/deepseek.mdx
@@ -0,0 +1,22 @@
+---
+title: DeepSeek
+description: DeepSeek model configuration
+---
+
+Use OpenAI-compatible configuration:
+
+```json
+{
+  "model": "deepseek-chat",
+  "bot_type": "chatGPT",
+  "open_ai_api_key": "YOUR_API_KEY",
+  "open_ai_api_base": "https://api.deepseek.com/v1"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | `deepseek-chat` (DeepSeek-V3), `deepseek-reasoner` (DeepSeek-R1) |
+| `bot_type` | Must be `chatGPT` (OpenAI-compatible mode) |
+| `open_ai_api_key` | Create at [DeepSeek Platform](https://platform.deepseek.com/api_keys) |
+| `open_ai_api_base` | DeepSeek platform BASE URL |
--- a/docs/en/models/doubao.mdx
+++ b/docs/en/models/doubao.mdx
@@ -0,0 +1,17 @@
+---
+title: Doubao (ByteDance)
+description: Doubao (Volcano Ark) model configuration
+---
+
+```json
+{
+  "model": "doubao-seed-2-0-code-preview-260215",
+  "ark_api_key": "YOUR_API_KEY"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Options include `doubao-seed-2-0-code-preview-260215`, `doubao-seed-2-0-pro-260215`, `doubao-seed-2-0-lite-260215`, etc. |
+| `ark_api_key` | Create at [Volcano Ark Console](https://console.volcengine.com/ark/region:ark+cn-beijing/apikey) |
+| `ark_base_url` | Optional. Defaults to `https://ark.cn-beijing.volces.com/api/v3` |
--- a/docs/en/models/gemini.mdx
+++ b/docs/en/models/gemini.mdx
@@ -0,0 +1,16 @@
+---
+title: Gemini
+description: Google Gemini model configuration
+---
+
+```json
+{
+  "model": "gemini-3.1-pro-preview",
+  "gemini_api_key": "YOUR_API_KEY"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Options include `gemini-3.1-pro-preview`, `gemini-3-flash-preview`, `gemini-3-pro-preview`, `gemini-2.5-pro`, `gemini-2.0-flash`, etc. See [official docs](https://ai.google.dev/gemini-api/docs/models) |
+| `gemini_api_key` | Create at [Google AI Studio](https://aistudio.google.com/app/apikey) |
--- a/docs/en/models/glm.mdx
+++ b/docs/en/models/glm.mdx
@@ -0,0 +1,27 @@
+---
+title: GLM (Zhipu AI)
+description: Zhipu AI GLM model configuration
+---
+
+```json
+{
+  "model": "glm-5",
+  "zhipu_ai_api_key": "YOUR_API_KEY"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Options include `glm-5`, `glm-4.7`, `glm-4-plus`, `glm-4-flash`, `glm-4-air`, etc. See [model codes](https://bigmodel.cn/dev/api/normal-model/glm-4) |
+| `zhipu_ai_api_key` | Create at [Zhipu AI Console](https://www.bigmodel.cn/usercenter/proj-mgmt/apikeys) |
+
+OpenAI-compatible configuration is also supported:
+
+```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/en/models/index.mdx
+++ b/docs/en/models/index.mdx
@@ -0,0 +1,55 @@
+---
+title: Models Overview
+description: Supported models and recommended choices for CowAgent
+---
+
+CowAgent supports mainstream LLMs from domestic and international providers. Model interfaces are implemented in the project's `models/` directory.
+
+<Note>
+  For Agent mode, the following models are recommended based on quality and cost: MiniMax-M2.5, glm-5, kimi-k2.5, qwen3.5-plus, claude-sonnet-4-6, gemini-3.1-pro-preview
+</Note>
+
+## Configuration
+
+Configure the model name and API key in `config.json` according to your chosen model. Each model also supports OpenAI-compatible access by setting `bot_type` to `chatGPT` and configuring `open_ai_api_base` and `open_ai_api_key`.
+
+You can also use the [LinkAI](https://link-ai.tech) platform interface to flexibly switch between multiple models with support for knowledge base, workflows, and other Agent capabilities.
+
+## Supported Models
+
+<CardGroup cols={2}>
+  <Card title="MiniMax" href="/en/models/minimax">
+    MiniMax-M2.5 and other series models
+  </Card>
+  <Card title="GLM (Zhipu AI)" href="/en/models/glm">
+    glm-5, glm-4.7 and other series models
+  </Card>
+  <Card title="Qwen (Tongyi Qianwen)" href="/en/models/qwen">
+    qwen3.5-plus, qwen3-max and more
+  </Card>
+  <Card title="Kimi" href="/en/models/kimi">
+    kimi-k2.5, kimi-k2 and more
+  </Card>
+  <Card title="Doubao (ByteDance)" href="/en/models/doubao">
+    doubao-seed series models
+  </Card>
+  <Card title="Claude" href="/en/models/claude">
+    claude-sonnet-4-6 and more
+  </Card>
+  <Card title="Gemini" href="/en/models/gemini">
+    gemini-3.1-pro-preview and more
+  </Card>
+  <Card title="OpenAI" href="/en/models/openai">
+    gpt-4.1, o-series and more
+  </Card>
+  <Card title="DeepSeek" href="/en/models/deepseek">
+    deepseek-chat, deepseek-reasoner
+  </Card>
+  <Card title="LinkAI" href="/en/models/linkai">
+    Unified multi-model interface + knowledge base
+  </Card>
+</CardGroup>
+
+<Tip>
+  For a full list of model names, refer to the project's [`common/const.py`](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/common/const.py) file.
+</Tip>
--- a/docs/en/models/kimi.mdx
+++ b/docs/en/models/kimi.mdx
@@ -0,0 +1,27 @@
+---
+title: Kimi (Moonshot)
+description: Kimi (Moonshot) model configuration
+---
+
+```json
+{
+  "model": "kimi-k2.5",
+  "moonshot_api_key": "YOUR_API_KEY"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Options include `kimi-k2.5`, `kimi-k2`, `moonshot-v1-8k`, `moonshot-v1-32k`, `moonshot-v1-128k` |
+| `moonshot_api_key` | Create at [Moonshot Console](https://platform.moonshot.cn/console/api-keys) |
+
+OpenAI-compatible configuration is also supported:
+
+```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/en/models/linkai.mdx
+++ b/docs/en/models/linkai.mdx
@@ -0,0 +1,23 @@
+---
+title: LinkAI
+description: Unified access to multiple models via LinkAI platform
+---
+
+The [LinkAI](https://link-ai.tech) platform lets you flexibly switch between OpenAI, Claude, Gemini, DeepSeek, Qwen, Kimi, and other models, with support for knowledge base, workflows, plugins, and other Agent capabilities.
+
+```json
+{
+  "use_linkai": true,
+  "linkai_api_key": "YOUR_API_KEY",
+  "linkai_app_code": "YOUR_APP_CODE"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `use_linkai` | Set to `true` to enable LinkAI interface |
+| `linkai_api_key` | Create at [LinkAI Console](https://link-ai.tech/console/interface) |
+| `linkai_app_code` | Optional. Code of the LinkAI agent (app or workflow) |
+| `model` | Leave empty to use the agent's default model. Can be switched flexibly on the platform. All models in the [model list](https://link-ai.tech/console/models) are supported |
+
+See the [API documentation](https://docs.link-ai.tech/platform/api) for more details.
--- a/docs/en/models/minimax.mdx
+++ b/docs/en/models/minimax.mdx
@@ -0,0 +1,27 @@
+---
+title: MiniMax
+description: MiniMax model configuration
+---
+
+```json
+{
+  "model": "MiniMax-M2.5",
+  "minimax_api_key": "YOUR_API_KEY"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Options include `MiniMax-M2.5`, `MiniMax-M2.1`, `MiniMax-M2.1-lightning`, `MiniMax-M2`, etc. |
+| `minimax_api_key` | Create at [MiniMax Console](https://platform.minimaxi.com/user-center/basic-information/interface-key) |
+
+OpenAI-compatible configuration is also supported:
+
+```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/en/models/openai.mdx
+++ b/docs/en/models/openai.mdx
@@ -0,0 +1,19 @@
+---
+title: OpenAI
+description: OpenAI model configuration
+---
+
+```json
+{
+  "model": "gpt-4.1-mini",
+  "open_ai_api_key": "YOUR_API_KEY",
+  "open_ai_api_base": "https://api.openai.com/v1"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Matches the [model parameter](https://platform.openai.com/docs/models) of the OpenAI API. Supports o-series, gpt-5.2, gpt-5.1, gpt-4.1, etc. |
+| `open_ai_api_key` | Create at [OpenAI Platform](https://platform.openai.com/api-keys) |
+| `open_ai_api_base` | Optional. Change to use third-party proxy |
+| `bot_type` | Not required for official OpenAI models. Set to `chatGPT` when using Claude or other non-OpenAI models via proxy |
--- a/docs/en/models/qwen.mdx
+++ b/docs/en/models/qwen.mdx
@@ -0,0 +1,27 @@
+---
+title: Qwen (Tongyi Qianwen)
+description: Tongyi Qianwen model configuration
+---
+
+```json
+{
+  "model": "qwen3.5-plus",
+  "dashscope_api_key": "YOUR_API_KEY"
+}
+```
+
+| Parameter | Description |
+| --- | --- |
+| `model` | Options include `qwen3.5-plus`, `qwen3-max`, `qwen-max`, `qwen-plus`, `qwen-turbo`, `qwq-plus`, etc. |
+| `dashscope_api_key` | Create at [Bailian Console](https://bailian.console.aliyun.com/?tab=model#/api-key). See [official docs](https://bailian.console.aliyun.com/?tab=api#/api) |
+
+OpenAI-compatible configuration is also supported:
+
+```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"
+}
+```