Skip to content

Commit 608d804

Browse files
SoulterSoulter
committed
feat: add model service connection guide and update notices in documentation
1 parent 9dfa01e commit 608d804

File tree

5 files changed

+65
-8
lines changed

5 files changed

+65
-8
lines changed

‎.vitepress/config.mjs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ export default defineConfig({
124124
base: "/config/providers",
125125
collapsed: true,
126126
items: [
127+
{ text: "✨ 接入模型服务", link: "/start" },
127128
{ text: "NewAPI", link: "/newapi" },
128129
{ text: "PPIO 派欧云", link: "/ppio" },
129130
{ text: "硅基流动", link: "/siliconflow" },
@@ -340,6 +341,7 @@ export default defineConfig({
340341
base: "/en/config/providers",
341342
collapsed: true,
342343
items: [
344+
{ text: "✨ Connecting LLM Services", link: "/start" },
343345
{ text: "NewAPI", link: "/newapi" },
344346
{ text: "PPIO Cloud", link: "/ppio" },
345347
{ text: "SiliconFlow", link: "/siliconflow" },

‎en/config/providers/start.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Connecting Model Services
2+
3+
AstrBot supports the native API formats of OpenAI, Google GenAI, and Anthropic. You can connect any model service provider that conforms to one of these three API formats.
4+
5+
For example, you may choose to connect model services provided by (but not limited to):
6+
7+
- Official OpenAI model services ([OpenAI](https://openai.com/))
8+
- Official Anthropic model services ([Anthropic](https://www.anthropic.com/))
9+
- Google's Gemini model services via Google Cloud ([Google Cloud](https://cloud.google.com/))
10+
- OpenRouter model services ([OpenRouter](https://openrouter.ai/))
11+
12+
Using DeepSeek as an example, assuming you have registered and logged in to a DeepSeek account, the steps to connect are:
13+
14+
1. Go to the DeepSeek Console (https://platform.deepseek.com/).
15+
2. Click the "API Keys" menu in the left sidebar, create a new API Key, and copy the key.
16+
3. Click the "API Documentation" link near the bottom of the left sidebar to open the API documentation page.
17+
4. On the API documentation page, find the section about the "OpenAI-compatible interface" and note the API Base URL, for example `https://api.deepseek.com/v1`. (If there is no `/v1`, please add `/v1`.)
18+
5. Open the AstrBot Console -> Service Providers page, click Add Provider, find and click `OpenAI` (if the provider type you want to connect is listed, prefer clicking that type; for some providers like DeepSeek we provide optimized adapter support). Paste the API Key into the `API Key` field of the form and paste the API Base URL into the `API Base URL` field.
19+
6. Click Get Model List, find the model you want to use, click the + button on the right, then toggle the switch that appears on the right to enable it.
20+
7. Go to the Configuration page, find the conversational model, click the selection button on the right, choose the provider and model you just added, then click the Save Configuration button at the bottom-right of the screen.

‎en/what-is-astrbot.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,17 @@ AstrBot is an open-source, all-in-one agentic chatbot platform and development f
1414
- **Plugin Extensions**. Deeply optimized plugin mechanism for extending functionality, with a thriving community plugin ecosystem.
1515
- **WebUI**. Feature-rich visual configuration and management interface.
1616

17+
## Notice
18+
19+
1. AstrBot is a non-profit project under the AstrBotDevs organization, maintained by passionate open-source contributors worldwide, and protected by the [AGPL-v3](https://www.chinasona.org/gnu/agpl-3.0-cn.html) open-source license. If you modify AstrBot and use it to provide commercial network services, you must open-source your modifications. Failure to do so constitutes a license violation, and we reserve the right to pursue legal action against such violations. For details, contact [[email protected]](mailto:[email protected]).
20+
2. Before using this project, please make sure to read the End User License Agreement (EULA): [End User License Agreement](https://github.com/AstrBotDevs/AstrBot/blob/master/EULA.md). If you do not agree to any terms of the agreement, do not use this project.
21+
1722
## How Does It Work?
1823

1924
The topology diagram below provides an overview of AstrBot's architecture.
2025

2126
![Architecture](/source/images/what-is-astrbot/image.png)
2227

23-
## Notice
24-
25-
AstrBot is currently a non-profit project under the AstrBotDevs non-profit organization, maintained by passionate open-source contributors worldwide, and protected by the [AGPL-v3](https://www.chinasona.org/gnu/agpl-3.0-cn.html) open-source license. If you modify AstrBot and use it to provide commercial network services, you must open-source your modifications. Failure to do so constitutes a license violation, and we reserve the right to pursue legal action against such violations. For details, contact [[email protected]](mailto:[email protected]).
26-
2728
## Visual Identity
2829

2930
### Logo (Nameless)

‎zh/config/providers/start.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# 接入模型服务
2+
3+
AstrBot 适配了 OpenAI、Google GenAI、Anthropic 三种原生 API 格式。您可以接入任意符合这三种 API 格式之一的模型服务提供商。
4+
5+
> [!NOTE]
6+
> 如果您位于中国大陆境内，我们强烈建议您使用符合当地法律法规的由**模型厂商官方提供的**或经过备案的模型服务提供商，例如：
7+
>
8+
> - [MoonshotAI](https://moonshot.cn/)
9+
> - [GLM](https://bigmodel.cn/)
10+
> - [MiniMax](https://www.minimax.io/)
11+
> - [Qwen](https://qwen.ai/apiplatform)
12+
> - [DeepSeek](https://deepseek.com/)
13+
>
14+
> 上述提供商均支持 OpenAI API 格式，您可以通过其文档中有关 “OpenAI 格式接入” 的说明，找到 API Base URL 及 API Key，然后将其填入 AstrBot 的提供商配置中。
15+
>
16+
> 请注意，使用未经备案的第三方模型服务提供商可能会导致服务不可用、信息泄露或其他法律风险，请谨慎选择。更多内容，请阅读我们的最终用户许可协议（[EULA](https://github.com/AstrBotDevs/AstrBot/blob/master/EULA.md)）。
17+
18+
例如，您可以选择接入如下（但不限于）模型提供商提供的模型服务：
19+
20+
- OpenAI 官方提供的模型服务（[OpenAI 官方网站](https://openai.com/)）
21+
- Anthropic 官方提供的模型服务（[Anthropic 官方网站](https://www.anthropic.com/)）
22+
- Google 提供的 Gemini 模型服务（[Google Cloud 官方网站](https://cloud.google.com/)）
23+
- OpenRouter 提供的模型服务（[OpenRouter 官方网站](https://openrouter.ai/)）
24+
25+
以 DeepSeek 为例，假设您已经注册并登录了 DeepSeek 账户，接入步骤如下：
26+
27+
1. 进入 [DeepSeek 控制台](https://platform.deepseek.com/)。
28+
2. 点击左侧导航栏的 “API Keys” 菜单，创建一个新的 API Key，并复制该 Key。
29+
3. 点击左侧导航栏下方的 “接口文档” 链接，进入 API 文档页面。
30+
4. 在 API 文档页面中，找到 “OpenAI 兼容接口” 相关的内容，记下 API Base URL，例如 `https://api.deepseek.com/v1`。（如果没有 /v1，就请加上 /v1）。
31+
5. 打开 AstrBot 控制台 -> 服务提供商页面，点击新增提供商，找到并点击 `OpenAI`（如果其中有您想要接入的提供商的类型，请优先点击那些类型，如 DeepSeek，我们会针对部分提供商做适配优化）。将 API Key 填入对话框表单的 `API Key` 处，将 API Base URL 填入 `API Base URL` 处。
32+
6. 点击获取模型列表，找到您想要使用的模型名称，点击右侧 + 号，然后将右侧的出现的开关打开。
33+
7. 进入配置文件页面，找到对话模型，点击右侧的选择按钮，选择刚刚添加的提供商和模型，点击屏幕右下角的保存配置按钮即可。

‎zh/what-is-astrbot.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,17 @@ AstrBot 致力于成为一个开源、一站式的 Agentic 聊天机器人平台
1313
- 广泛平台支持： 一键部署至 QQ、企业微信、微信公众号、飞书、Telegram、钉钉、Discord 等主流平台，提供安全与稳定保障。
1414
- 插件与 WebUI： 深度优化插件扩展机制，以及可视化 WebUI 进行配置和管理。
1515

16+
## 说明
17+
18+
1. AstrBot 是一个非盈利项目，由全世界热心开源贡献者维护，并受 [AGPL-v3](https://www.chinasona.org/gnu/agpl-3.0-cn.html) 开源许可证保护。如果您对 AstrBot 进行了修改并将其用于提供具有商业盈利性质的网络服务，您必须开源所做的修改。详细联系 [[email protected]](mailto:[email protected])。
19+
2. 使用此项目前，请务必阅读本项目的最终用户许可协议（EULA）：[最终用户许可协议](https://github.com/AstrBotDevs/AstrBot/blob/master/EULA.md)。如果您不同意该协议的任何条款，请勿使用本项目。
20+
1621
## 它是如何实现的？
1722

1823
下面的拓扑图基本简述了 AstrBot 的架构。
1924

2025
![Architecture](/source/images/what-is-astrbot/image.png)
2126

22-
## 说明
23-
24-
AstrBot 目前是一个非盈利项目，位于 AstrBotDevs 非盈利组织下，由全世界热心开源贡献者维护，并受 [AGPL-v3](https://www.chinasona.org/gnu/agpl-3.0-cn.html) 开源许可证保护。如果您对 AstrBot 进行了修改并将其用于提供具有商业盈利性质的网络服务，您必须开源所做的修改，否则将构成对许可证的违反，我们将保留对违反许可证条款的行为追究法律责任的权利。详细联系 [[email protected]](mailto:[email protected]) 。
25-
2627
## 视觉形象
2728

2829
### Logo (Nameless)

0 commit comments

Comments
 (0)