Skip to content

Commit

Permalink
feat
Browse files Browse the repository at this point in the history
  • Loading branch information
Soulter committed Aug 2, 2024
1 parent a2f0a2b commit b19e518
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 21 deletions.
34 changes: 34 additions & 0 deletions docs/使用/从零开始.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
本页面将指导您如何从零开始运行 AstrBot。

## 1. 运行项目

本项目支持 3 种部署方式:

1. 使用 Windows 启动器快速部署,适用于 Windows 环境;
2. 使用 Docker 部署,适用于 Windows 和 Linux 环境;
3. 直接通过源码部署。

请从左侧导航栏选择对应的部署方式进行查看。

## 2. 接入到平台

在运行好之后,您一定希望将 AstrBot 接入到 QQ 等平台。

### 接入到 QQ 或者 QQ频道

本项目支持多种接入 QQ 的方式,包括:

- 使用诸如 Napcat、Lagrange、LLoneBot、Shamrock、go-cqhttp 等项目接入;
- 使用QQ官方机器人接入

请从左侧导航栏查看 [平台配置][../配置/平台配置] 文档。

接入成功后,你可以尝试在你接入的地方给机器人发送 `help` 指令或者 `myid`,查看是否成功返回。如果没有成功返回,请在 AstrBot 的日志中查看是否有相关响应。如果有错误并且无法自行解决,请反馈到 issue。

## 接入 LLM

在接入平台成功后,您可能希望接入 LLM 以提供对话体验。

请查看 [大语言模型](../使用/大语言模型)

在填写完相关信息并且保存后,你可以在任何一个支持聊天的地方与其对话来测试是否接入成功。
28 changes: 20 additions & 8 deletions docs/使用/大语言模型.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,27 @@ AstrBot 集成了大语言模型的一些功能。
:::

## 🌍支持的AI语言模型一览:
- OpenAI GPT-3模型(原生支持)
- OpenAI GPT-3.5模型(原生支持)
- OpenAI GPT-4模型(原生支持)
- OpenAI 各类模型(需自行申请API Key 或者第三方服务)
- Claude(免费,由[LLMs插件](https://github.com/Soulter/LLMS)支持)
- HuggingChat(免费,由[LLMs插件](https://github.com/Soulter/LLMS)支持)
- 任何与 OpenAI Chat API 接口一致的第三方语言模型服务

## OpenAI
## OpenAI API

如果您有 OpenAI API Key,可以直接在 `可视化面板-配置` 页面中添加。如果你用的是与 OpenAI Chat API 接口一致的第三方语言模型服务,请填完 key 之后,修改 `api base` 项。
> 本接入方式不仅支持 OpenAI 官方的模型,亦支持与 OpenAI Chat API 接口一致的第三方语言模型服务。如国内的众多 OpenAI 中转服务、文心一言、Deepseek等。
如果您有 OpenAI API Key,可以直接在 `可视化面板-配置` 页面中添加。如果你用的是与 OpenAI Chat API 接口一致的模型服务,请填完 key 之后,修改 `api base` 项。如何填写 `api base` 请参考你的第三方服务的文档。

> 某些第三方服务可能模型名称,AstrBot 默认使用的模型是 `gpt-4o` 可能这些第三方服务不支持。请记得在下面也修改一下模型名称为你的模型服务支持的模型名。
![llm](image-3.png)

可以直接在 `可视化面板-配置` 页面中修改语言、图片模型的配置。
### 使用 GPT_API_free 快速接入测试

如果你还没有任何可用的模型服务,你可以尝试一下使用如下项目来获得一个免费的 OpenAI API Key。

https://github.com/chatanywhere/GPT_API_free

你也可以使用完全免费的OpenAI ChatGPT,由 https://github.com/chatanywhere/GPT_API_free 提供支持。
打开这个链接,然后点击**申请免费内测**,就可以得到一个免费的第三方key,把它复制下来。

然后,修改 `OpenAI API 节点地址` 为以下任意一个:
Expand All @@ -29,4 +34,11 @@ AstrBot 集成了大语言模型的一些功能。

记住修改完之后点击右下角的保存按钮。

有经济能力可支持 https://github.com/chatanywhere/GPT_API_free 购买低价key,获得更多模型。
有经济能力可支持 https://github.com/chatanywhere/GPT_API_free 购买低价key,获得更多模型。

在保存并且 AstrBot 重启成功后,你可以在任何一个支持聊天的地方与其对话来测试是否接入成功。


## LLMS 插件

LLMS 插件支持接入 Gemini、HuggingChat 等服务。详见 [LLMS 插件](https://github.com/soulter/llms)
8 changes: 5 additions & 3 deletions docs/开始.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@

:::info

如果在使用过程中遇到了任何问题,欢迎提交 [issue](https://github.com/Soulter/AstrBot/issues) 或者加群 322154837 讨论
如果在使用过程中遇到任何问题,欢迎提交 [issue](https://github.com/Soulter/AstrBot/issues) 或者加群 322154837。

此文档正在建设中,欢迎您参与建设!如果发现文档错误可以点击每篇文章末尾的 `Edit this page` 来修改文章。合并修改后,会自动更新页面
此文档正在建设中,欢迎参与建设!如果发现文档错误可以点击每篇文章末尾的 `Edit this page` 修改文章

:::
:::

如果你准备开始运行这个项目,请查看 [从零开始](../使用/从零开始) 文档。
Binary file added docs/配置/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 28 additions & 10 deletions docs/配置/平台配置.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Nakuru, AIOCQhttp 和 QQ官方机器人接口

- `Nakuru``AioCQHttp` 是 AstrBot 中使用的对 OneBot 协议(QQ)的支持库。其中,`Nakuru` 更适合连接到 `go-cqhttp`,而 `AioCQHttp` 适合连接到支持反向 Websocket 的 OneBot 协议实现,如 `NapCat`, `Lagrange`, `Shamrock` 等。
- `nakuru``aiocqhttp` 是 AstrBot 中使用的对 OneBot 协议(QQ)的支持库。其中,`Nakuru` 更适合连接到 `go-cqhttp`,而 `aiocqhttp` 适合连接到支持反向 Websocket 的 OneBot 协议实现,如 `Napcat`, `Lagrange`, `Shamrock` 等。

> 更推荐使用 aiocqhttp 来接入。
Expand All @@ -17,11 +17,13 @@
- NapCat: [点击查看](https://napneko.github.io/zh-CN/guide/getting-started)
- Lagrange.OneBot: [点击查看](https://lagrangedev.github.io/Lagrange.Doc/Lagrange.OneBot/Config/#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6)
- Shamrock: [点击查看](https://whitechi73.github.io/OpenShamrock/guide/configuration.html#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6)
- go-cqhttp(不推荐): [点击查看](https://docs.go-cqhttp.org/guide/config.html#%E9%85%8D%E7%BD%AE%E4%BF%A1%E6%81%AF)
- go-cqhttp: [点击查看](https://docs.go-cqhttp.org/guide/config.html#%E9%85%8D%E7%BD%AE%E4%BF%A1%E6%81%AF)

> 如果您之前没运行过相关的项目,我们建议您选用 Napcat、Lagrange.OneBot、LLoneBot 等基于 QQNT 的项目,成功率较高。
1. 在各协议实现中配置好反向 Websocket 的 host 和 port。host 如 `127.0.0.1`,port 如 `6199`
2. 在协议实现端启用反向 Websocket。连接到 `ws://host:port/ws`注意是 `/ws` 路由
3. 打开可视化面板->配置页->QQ(aiocqhttp),点击右边的 `配置` 按钮,在下方出现的配置项中填写好 host 和 port,并启用。
2. 在协议实现端启用反向 Websocket。连接到 `ws://host:port/ws`(请特别注意是 `/ws` 路由!)
3. 打开`可视化面板->配置页->QQ(aiocqhttp)`,点击右边的 `配置` 按钮,在下方出现的配置项中填写好 host 和 port,并启用。
> 注意:如果您正在使用 Docker 部署 AstrBot,您需要暴露对应的端口,并且 host 建议填写 `0.0.0.0`
1. 点击右下角的保存按钮。

Expand Down Expand Up @@ -76,17 +78,33 @@ servers:

### 申请一个机器人

> 需要注意以下几点
> 1. QQ官方机器人目前仅对外开放QQ频道的接入
> 您可能需要注意以下几点
> 1. QQ官方机器人目前对外开放QQ频道、QQ群、QQ私聊。但是QQ群和QQ私聊能力需要审核,审核需要花费时间
> 2. 分为公域和私域机器人。前者支持任何人拉机器人到自己的频道,后者仅支持自己设置频道白名单。默认为私域。
> 3. 如果您的**现在的**(也就是说,加入机器人之后,就没有这个人数限制)频道人数小于20人,那么可以很方便地将机器人拉入您的频道,只需要在q.qq.com设置沙箱频道即可
> 3. 如果您的**现在的**(也就是说,加入机器人之后,就没有这个人数限制)频道/QQ群人数小于20人,那么可以很方便地将机器人拉入您的频道/群,只需要在q.qq.com设置沙箱频道/群即可
> 4. 如果您想将机器人拉入>=20人的频道,那么您必须在q.qq.com上线机器人,这需要写提审报告等等,教程请参见q.qq.com上的官方教程。需要注意的是,在提审过程中,请务必确保不启用LLM能力(或者隐藏起来——在可视化面板-配置项中填写 LLM唤醒词。),否则可能审核失败。
请移步 q.qq.com 申请。申请完毕之后可以在`开发设置`中找到 appid、secret。

打开可视化面板-配置页的 `QQ_OFFICIAL` 配置项,启用并填写 appid、secret 即可。记得右下角保存。
首先,打开 [QQ官方机器人](https://q.qq.com) 并登录。

然后,点击创建机器人,填写名称、简介、头像等信息。然后点击下一步、提交审核。等待安全校验通过后,创建成功。

点击创建好的机器人,然后你将会被导航到机器人的管理页面。如下图所示:

![](../image.png)

我们点击沙箱配置,这允许你立即设置一个沙箱频道/群/私聊,用于拉入机器人(需要小于等于20个人)。

然后你将会看到 QQ 群配置、消息列表配置和 QQ 频道配置。根据你的需求来选择QQ群、允许私聊的QQ号、QQ频道。

显示添加成功后,前往对应的地方,拉入机器人。
- QQ群:点击群右上角,往下滑找到群机器人,点击,往下滑,在`其他`一栏找到机器人,点击添加即可。
- 消息列表:点击`添加成员`的左侧的二维码按钮,扫码即可。
- QQ频道:点击频道右上角,点击`机器人`,往下滑,找到机器人,点击添加即可。

添加机器人到你想用的地方后,点击`开发->开发设置`,找到 appid、secret。复制。

将机器人拉入您的QQ频道即可
打开机器人可视化面板,点击 `配置` 页的 `QQ官方` 配置项,启用,并填写 appid、secret 即可。记得右下角保存

## Telegram

Expand Down

0 comments on commit b19e518

Please sign in to comment.