AI/GPT 模块
类路径:GptController
前缀:/gpt
1. sendMsg
接口路径:POST /gpt/sendMsg
权限:需要登录(普通用户及以上)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| gptid | Integer | 否 | - | |
| msg | String | 否 | - | |
| platform | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.sendMsg() (https://api.ruletree.club/typechoChat/sendMsg)
- 前端调用:this.$API.gptSendMsg() (https://api.ruletree.club/gpt/sendMsg)
2. sendText
接口路径:POST /gpt/sendText
权限:需要登录(普通用户及以上)
接口说明:发送文本(针对AI应用)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| gptid | Integer | 否 | - | |
| msg | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptSendText() (https://api.ruletree.club/gpt/sendText)
3. lastMsg
接口路径:GET/POST /gpt/lastMsg
权限:需要登录(普通用户及以上)
接口说明:获取最新的消息,限制条数
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| gptid | Integer | 否 | - | |
| limit | Integer | 否 | 50 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptLastMsg() (https://api.ruletree.club/gpt/lastMsg)
4. msgList
接口路径:POST /gpt/msgList
权限:需要登录(普通用户及以上)
接口说明:消息分页查询(用于查询历史记录)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| gptid | Integer | 否 | - | |
| page | Integer | 否 | - | |
| searchKey | String | 否 | - | |
| limit | Integer | 否 | 50 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.msgList() (https://api.ruletree.club/typechoChat/msgList)
- 前端调用:this.$API.gptMsgList() (https://api.ruletree.club/gpt/msgList)
5. systemMsgList
接口路径:POST /gpt/systemMsgList
权限:需要超级管理员权限
接口说明:管理员消息分页查询
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | - | |
| searchKey | String | 否 | - | |
| limit | Integer | 否 | 50 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.msgList() (https://api.ruletree.club/typechoChat/msgList)
- 前端调用:this.$API.gptSystemMsgList() (https://api.ruletree.club/gpt/systemMsgList)
6. gptAdd
接口路径:GET/POST /gpt/gptAdd
权限:需要超级管理员权限
接口说明:增加AI
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptAdd() (https://api.ruletree.club/gpt/gptAdd)
7. gptEdit
接口路径:GET/POST /gpt/gptEdit
权限:需要超级管理员权限
接口说明:修改AI
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptEdit() (https://api.ruletree.club/gpt/gptEdit)
8. gptDelete
接口路径:GET/POST /gpt/gptDelete
权限:需要超级管理员权限
接口说明:删除AI
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| id | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptDelete() (https://api.ruletree.club/gpt/gptDelete)
9. gptList
接口路径:GET/POST /gpt/gptList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:AI列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| searchKey | String | 否 | - | |
| page | Integer | 否 | 1 | |
| order | String | 否 | created | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptList() (https://api.ruletree.club/gpt/gptList)
10. gptInfo
接口路径:GET/POST /gpt/gptInfo
权限:需要登录(普通用户及以上)
接口说明:查询AI详情
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptInfo() (https://api.ruletree.club/gpt/gptInfo)
11. gptChatList
接口路径:GET/POST /gpt/gptChatList
权限:需要登录(普通用户及以上)
接口说明:AI聊天室列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| order | String | 否 | created | |
| limit | Integer | 否 | 15 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
12. gptChatInfo
接口路径:GET/POST /gpt/gptChatInfo
权限:需要登录(普通用户及以上)
接口说明:AI聊天室详情
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
13. gptChatDelete
接口路径:GET/POST /gpt/gptChatDelete
权限:需要登录(普通用户及以上)
接口说明:删除AI聊天室
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| id | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptChatDelete() (https://api.ruletree.club/gpt/gptChatDelete)
14. batchGenerate
接口路径:POST /gpt/batchGenerate
权限:需要超级管理员权限
接口说明:AI批量生成(后台调用,使用AI配置但不使用其提示词)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| gptid | Integer | 否 | - | |
| prompt | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
15. testAI
接口路径:POST /gpt/test
权限:需要超级管理员权限
接口说明:AI测试接口(仅文字模型) 支持直接传模型源ID测试,或传完整参数测试
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| sourceId | Integer | 否 | - | |
| gptid | Integer | 否 | - | |
| prompt | String | 否 | 你好,请简单介绍一下自己 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
16. sendAIAssistant
接口路径:POST /gpt/sendAIAssistant
权限:需要登录(普通用户及以上)
接口说明:发送给AI助手
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| msg | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.sendAIAssistant() (https://api.ruletree.club/gpt/sendAIAssistant)
17. sourceList
接口路径:GET/POST /gpt/sourceList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:模型源列表(公开)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| searchKey | String | 否 | - | |
| page | Integer | 否 | 1 | |
| order | String | 否 | orderKey | |
| limit | Integer | 否 | 100 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptSourceList() (https://api.ruletree.club/gpt/sourceList)
18. sourceInfo
接口路径:GET/POST /gpt/sourceInfo
权限:需要登录(普通用户及以上)
接口说明:模型源详情
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
19. sourceAdd
接口路径:GET/POST /gpt/sourceAdd
权限:需要超级管理员权限
接口说明:添加模型源
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
20. sourceEdit
接口路径:GET/POST /gpt/sourceEdit
权限:需要超级管理员权限
接口说明:编辑模型源
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
21. sourceDelete
接口路径:GET/POST /gpt/sourceDelete
权限:需要超级管理员权限
接口说明:删除模型源
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| id | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
22. categoryList
接口路径:GET/POST /gpt/categoryList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:分类列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| searchKey | String | 否 | - | |
| page | Integer | 否 | 1 | |
| order | String | 否 | orderKey | |
| limit | Integer | 否 | 200 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptCategoryList() (https://api.ruletree.club/gpt/categoryList)
23. categoryAdd
接口路径:GET/POST /gpt/categoryAdd
权限:需要超级管理员权限
接口说明:添加分类
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
24. categoryEdit
接口路径:GET/POST /gpt/categoryEdit
权限:需要超级管理员权限
接口说明:编辑分类
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
25. categoryDelete
接口路径:GET/POST /gpt/categoryDelete
权限:需要超级管理员权限
接口说明:删除分类
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| id | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
26. generate
接口路径:POST /gpt/generate
权限:需要登录(普通用户及以上)
接口说明:图片/视频生成(公开接口)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| gptid | Integer | 否 | - | |
| prompt | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.gptGenerate() (https://api.ruletree.club/gpt/generate)