WeChatFerry/clients/gohttp/README.md

45 lines
2.4 KiB
Markdown
Raw Normal View History

2024-08-26 13:28:25 +08:00
# Wrest Chat
2023-12-17 13:16:15 +08:00
2024-08-26 13:28:25 +08:00
智能聊天助手,是一个通用的聊天辅助程序,通过 **Nanomsg 协议** 与聊天软件互通,内置 WEB 管理界面可接入GPT、Gemini、星火、文心、混元、通义千问等大语言模型。目前已适配 *PC微信*,更多聊天软件适配中,敬请期待!
> 为保证客户端纯粹性,此包仅提供 HTTP 和 Websocket 接口能力,完整功能可参考 [wrest-chat](https://github.com/opentdp/wrest-chat) 项目说明
## 功能特性
这里仅列举了一些主要的特性,其他信息请参阅[项目文档](https://docs.opentdp.org/#/wrest/)by [KincaidYang](https://github.com/KincaidYang)
2024-01-10 09:59:47 +08:00
- 使用 Go 语言编写,无运行时依赖
- 提供 HTTP 接口,便于对接各类编程语言
- 提供 Websocket 接口,接收推送的新消息
2024-08-26 13:28:25 +08:00
- 支持 HTTP/WS 接口授权,参见 [配置文件解析](https://docs.opentdp.org/#/wrest/配置文件解析)
- 支持作为 SDK 使用,参见 [SDK模块说明](https://docs.opentdp.org/#/wrest/开发指南/SDK模块)
- 内置 AI 机器人,参见 [BOT模块说明](https://docs.opentdp.org/#/wrest/开发指南/BOT模块)
- 内置 Web 管理界面,可以管理机器人各项配置
- 内置 Api 调试工具,所有接口都可以在线调试
- 尽可能将消息中的 Xml 转为 Object便于前端解析
2024-08-26 13:28:25 +08:00
- 支持计划任务、外部指令、指令插件等扩展功能,详见 [wrest-plugin](https://github.com/opentdp/wrest-plugin)
2024-01-10 09:59:47 +08:00
2024-08-26 13:28:25 +08:00
## 代码提交
2024-08-26 13:28:25 +08:00
提交代码时请使用 `feat: something` 作为说明,支持的标识如下
2024-08-26 13:28:25 +08:00
- `feat` 新功能feature
- `fix` 错误修复
- `docs` 文档更改documentation
- `style` 格式(不影响代码含义的更改,空格、格式、缺少分号等)
- `refactor` 重构即不是新功能也不是修补bug的代码变动
- `perf` 优化(提高性能的代码更改)
- `test` 测试(添加缺失的测试或更正现有测试)
- `chore` 构建过程或辅助工具的变动
- `revert` 还原以前的提交
2024-08-26 13:28:25 +08:00
## 免责声明
2024-01-10 09:59:47 +08:00
2024-08-26 13:28:25 +08:00
[WrestChat](https://github.com/opentdp/wrest-chat) 和 [WeChatFerry](https://github.com/lich0821/WeChatFerry) 是供学习交流的开源项目,代码及其制品仅供参考,不保证质量,不构成任何商业承诺或担保,不得用于商业或非法用途,使用者自行承担后果。
2023-12-27 18:26:35 +08:00
2024-08-26 13:28:25 +08:00
## 其他
2023-12-17 13:16:15 +08:00
2024-08-26 13:28:25 +08:00
License [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.txt)
2023-12-17 13:16:15 +08:00
2024-08-26 13:28:25 +08:00
Copyright (c) 2022 - 2024 OpenTDP