llm,doc

This commit is contained in:
2025-08-02 23:54:03 +08:00
parent 366ca479c4
commit e03259608e
17 changed files with 3836 additions and 212 deletions
+1195 -78
View File
File diff suppressed because it is too large Load Diff
+1193 -77
View File
File diff suppressed because it is too large Load Diff
+737 -46
View File
@@ -85,7 +85,7 @@ definitions:
description: 验证码长度
type: integer
open-captcha:
description: 防爆破验证码开启此数,0代表每次登录都需要验证码,其他数字代表错误密码此数,如3代表错误三次后出现验证码
description: 防爆破验证码开启此数,0代表每次登录都需要验证码,其他数字代表错误密码次数,如3代表错误三次后出现验证码
type: integer
open-captcha-timeout:
description: 防爆破验证码超时时间,单位:s(秒)
@@ -153,6 +153,24 @@ definitions:
description: 本地文件存储路径
type: string
type: object
config.MCP:
properties:
message_path:
description: 消息路径
type: string
name:
description: MCP名称
type: string
sse_path:
description: SSE路径
type: string
url_prefix:
description: URL前缀
type: string
version:
description: MCP版本
type: string
type: object
config.Minio:
properties:
access-key-id:
@@ -477,6 +495,10 @@ definitions:
allOf:
- $ref: '#/definitions/config.Local'
description: oss
mcp:
allOf:
- $ref: '#/definitions/config.MCP'
description: MCP配置
minio:
$ref: '#/definitions/config.Minio'
mongo:
@@ -505,6 +527,10 @@ definitions:
$ref: '#/definitions/config.System'
tencent-cos:
$ref: '#/definitions/config.TencentCOS'
volcengine:
allOf:
- $ref: '#/definitions/config.Volcengine'
description: Volcengine配置
zap:
$ref: '#/definitions/config.Zap'
type: object
@@ -645,6 +671,24 @@ definitions:
secret-key:
type: string
type: object
config.Volcengine:
properties:
access-key:
description: 火山引擎访问密钥ID
type: string
default-model:
description: 默认模型ID,如:ep-xxx
type: string
endpoint:
description: 服务端点,如:https://ark.cn-beijing.volces.com
type: string
region:
description: 区域,如:cn-beijing
type: string
secret-key:
description: 火山引擎访问密钥Secret
type: string
type: object
config.Zap:
properties:
director:
@@ -802,6 +846,9 @@ definitions:
host:
description: 服务器地址 例如 smtp.qq.com 请前往QQ或者你要发邮件的邮箱查看其smtp协议
type: string
is-loginauth:
description: 是否LoginAuth 是否使用LoginAuth认证方式(适用于IBM、微软邮箱服务器等)
type: boolean
is-ssl:
description: 是否SSL 是否开启SSL
type: boolean
@@ -1014,6 +1061,46 @@ definitions:
description: 是否前端表格列
type: boolean
type: object
request.AutoMcpTool:
properties:
description:
type: string
name:
type: string
params:
items:
properties:
default:
type: string
description:
type: string
name:
type: string
required:
type: boolean
type:
description: string, number, boolean, object, array
type: string
required:
- description
- name
- type
type: object
type: array
response:
items:
properties:
type:
description: text, image
type: string
required:
- type
type: object
type: array
required:
- description
- name
type: object
request.CasbinInReceive:
properties:
authorityId:
@@ -1042,6 +1129,34 @@ definitions:
description: 密码
type: string
type: object
request.ChatRequest:
properties:
max_tokens:
description: 最大生成token数
type: integer
messages:
description: 对话消息列表
items:
$ref: '#/definitions/request.Message'
type: array
model:
description: 模型名称,如果为空则使用默认模型
type: string
request_id:
description: 请求ID,用于流式响应管理
type: string
stream:
description: 是否流式响应,默认false
type: boolean
temperature:
description: 温度参数,控制随机性,范围0-1
type: number
top_p:
description: 核采样参数
type: number
required:
- messages
type: object
request.DataSource:
properties:
association:
@@ -1074,6 +1189,31 @@ definitions:
description: 每页大小
type: integer
type: object
request.ExportVersionRequest:
properties:
apiIds:
description: 选中的API ID列表
items:
type: integer
type: array
description:
description: 版本描述
type: string
menuIds:
description: 选中的菜单ID列表
items:
type: integer
type: array
versionCode:
description: 版本号
type: string
versionName:
description: 版本名称
type: string
required:
- versionCode
- versionName
type: object
request.GetAuthorityId:
properties:
authorityId:
@@ -1113,6 +1253,25 @@ definitions:
type: integer
type: array
type: object
request.ImportVersionRequest:
properties:
apis:
description: API数据,直接复用SysApi
items:
$ref: '#/definitions/system.SysApi'
type: array
menus:
description: 菜单数据,直接复用SysBaseMenu
items:
$ref: '#/definitions/system.SysBaseMenu'
type: array
version:
allOf:
- $ref: '#/definitions/request.VersionInfo'
description: 版本信息
required:
- version
type: object
request.InitDB:
properties:
adminPassword:
@@ -1160,6 +1319,18 @@ definitions:
description: 用户名
type: string
type: object
request.Message:
properties:
content:
description: 消息内容
type: string
role:
description: '角色: system, user, assistant'
type: string
required:
- content
- role
type: object
request.PageInfo:
properties:
keyword:
@@ -1257,6 +1428,14 @@ definitions:
id:
type: integer
type: object
request.StopRequest:
properties:
request_id:
description: 要停止的请求ID
type: string
required:
- request_id
type: object
request.SysAuthorityBtnReq:
properties:
authorityId:
@@ -1298,6 +1477,81 @@ definitions:
description: 主键ID
type: integer
type: object
request.VersionInfo:
properties:
code:
description: 版本号
type: string
description:
description: 版本描述
type: string
exportTime:
description: 导出时间
type: string
name:
description: 版本名称
type: string
required:
- code
- name
type: object
response.APIError:
properties:
code:
description: 错误代码
type: string
message:
description: 错误消息
type: string
type:
description: 错误类型
type: string
type: object
response.ChatResponse:
properties:
choices:
description: 响应选择列表
items:
$ref: '#/definitions/response.Choice'
type: array
created:
description: 创建时间戳
type: integer
error:
allOf:
- $ref: '#/definitions/response.APIError'
description: 错误信息
id:
description: 响应ID
type: string
model:
description: 使用的模型
type: string
object:
description: '对象类型: chat.completion 或 chat.completion.chunk'
type: string
usage:
allOf:
- $ref: '#/definitions/response.Usage'
description: 使用量统计(非流式响应)
type: object
response.Choice:
properties:
delta:
allOf:
- $ref: '#/definitions/response.Message'
description: 增量消息(流式)
finish_reason:
description: '结束原因: stop, length, content_filter'
type: string
index:
description: 选择索引
type: integer
message:
allOf:
- $ref: '#/definitions/response.Message'
description: 完整响应消息(非流式)
type: object
response.Email:
properties:
body:
@@ -1339,6 +1593,15 @@ definitions:
user:
$ref: '#/definitions/system.SysUser'
type: object
response.Message:
properties:
content:
description: 消息内容
type: string
role:
description: '角色: system, user, assistant'
type: string
type: object
response.PageResult:
properties:
list: {}
@@ -1364,6 +1627,21 @@ definitions:
msg:
type: string
type: object
response.StopResponse:
properties:
message:
description: 响应消息
type: string
request_id:
description: 请求ID
type: string
stopped_at:
description: 停止时间戳
type: integer
success:
description: 是否成功停止
type: boolean
type: object
response.SysAPIListResponse:
properties:
apis:
@@ -1436,6 +1714,18 @@ definitions:
user:
$ref: '#/definitions/system.SysUser'
type: object
response.Usage:
properties:
completion_tokens:
description: 输出token数
type: integer
prompt_tokens:
description: 输入token数
type: integer
total_tokens:
description: 总token数
type: integer
type: object
system.Condition:
properties:
ID:
@@ -1495,6 +1785,9 @@ definitions:
title:
description: 菜单名
type: string
transitionType:
description: 路由切换动画
type: string
type: object
system.SysApi:
properties:
@@ -1920,6 +2213,33 @@ definitions:
description: 用户UUID
type: string
type: object
system.SysVersion:
properties:
ID:
description: 主键ID
type: integer
createdAt:
description: 创建时间
type: string
description:
description: 版本描述
type: string
updatedAt:
description: 更新时间
type: string
versionCode:
description: 版本号
type: string
versionData:
description: 版本数据
type: string
versionName:
description: 版本名称
type: string
required:
- versionCode
- versionName
type: object
system.System:
properties:
config:
@@ -1929,7 +2249,7 @@ info:
contact: {}
description: 使用gin+vue进行极速开发的全栈开发基础平台
title: Gin-Vue-Admin Swagger API接口文档
version: v2.7.9-beta
version: v2.8.4
paths:
/api/createApi:
post:
@@ -2935,8 +3255,7 @@ paths:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
type: object
items: {}
type: array
msg:
type: string
@@ -2946,6 +3265,75 @@ paths:
summary: 安装插件
tags:
- AutoCodePlugin
/autoCode/mcp:
post:
consumes:
- application/json
parameters:
- description: 创建自动代码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.AutoMcpTool'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"创建成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 自动McpTool
tags:
- mcp
/autoCode/mcpList:
post:
consumes:
- application/json
parameters:
- description: 创建自动代码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.AutoMcpTool'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"创建成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 自动McpTool
tags:
- mcp
/autoCode/mcpTest:
post:
consumes:
- application/json
parameters:
- description: 调用MCP Tool的参数
in: body
name: data
required: true
schema:
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"测试成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- ApiKeyAuth: []
summary: 测试McpTool
tags:
- mcp
/autoCode/preview:
post:
consumes:
@@ -4525,18 +4913,6 @@ paths:
summary: 更新SysDictionaryDetail
tags:
- SysDictionaryDetail
/sysExportTemplate/ExportTemplate:
get:
consumes:
- application/json
produces:
- application/json
responses: {}
security:
- ApiKeyAuth: []
summary: 导出表格模板
tags:
- SysExportTemplate
/sysExportTemplate/createSysExportTemplate:
post:
consumes:
@@ -4618,6 +4994,42 @@ paths:
summary: 导出表格
tags:
- SysExportTemplate
/sysExportTemplate/exportExcelByToken:
get:
consumes:
- application/json
produces:
- application/json
responses: {}
security:
- ApiKeyAuth: []
summary: 导出表格
tags:
- ExportExcelByToken
/sysExportTemplate/exportTemplate:
get:
consumes:
- application/json
produces:
- application/json
responses: {}
security:
- ApiKeyAuth: []
summary: 导出表格模板
tags:
- SysExportTemplate
/sysExportTemplate/exportTemplateByToken:
get:
consumes:
- application/json
produces:
- application/json
responses: {}
security:
- ApiKeyAuth: []
summary: 通过token导出表格模板
tags:
- ExportTemplateByToken
/sysExportTemplate/findSysExportTemplate:
get:
consumes:
@@ -4781,34 +5193,6 @@ paths:
summary: 更新导出模板
tags:
- SysExportTemplate
/sysOperationRecord/createSysOperationRecord:
post:
consumes:
- application/json
parameters:
- description: 创建SysOperationRecord
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysOperationRecord'
produces:
- application/json
responses:
"200":
description: 创建SysOperationRecord
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建SysOperationRecord
tags:
- SysOperationRecord
/sysOperationRecord/deleteSysOperationRecord:
delete:
consumes:
@@ -5267,6 +5651,238 @@ paths:
summary: 更新参数
tags:
- SysParams
/sysVersion/deleteSysVersion:
delete:
consumes:
- application/json
parameters:
- description: 删除版本管理
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysVersion'
produces:
- application/json
responses:
"200":
description: 删除成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除版本管理
tags:
- SysVersion
/sysVersion/deleteSysVersionByIds:
delete:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 批量删除成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 批量删除版本管理
tags:
- SysVersion
/sysVersion/downloadVersionJson:
get:
consumes:
- application/json
parameters:
- description: 版本ID
in: query
name: ID
required: true
type: string
produces:
- application/json
responses:
"200":
description: 下载成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 下载版本JSON数据
tags:
- SysVersion
/sysVersion/exportVersion:
post:
consumes:
- application/json
parameters:
- description: 创建发版数据
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.ExportVersionRequest'
produces:
- application/json
responses:
"200":
description: 创建成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建发版数据
tags:
- SysVersion
/sysVersion/findSysVersion:
get:
consumes:
- application/json
parameters:
- description: 用id查询版本管理
in: query
name: ID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 查询成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.SysVersion'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用id查询版本管理
tags:
- SysVersion
/sysVersion/getSysVersionList:
get:
consumes:
- application/json
parameters:
- collectionFormat: csv
in: query
items:
type: string
name: createdAtRange
type: array
- description: 关键字
in: query
name: keyword
type: string
- description: 页码
in: query
name: page
type: integer
- description: 每页大小
in: query
name: pageSize
type: integer
- in: query
name: versionCode
type: string
- in: query
name: versionName
type: string
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取版本管理列表
tags:
- SysVersion
/sysVersion/getSysVersionPublic:
get:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: object
msg:
type: string
type: object
summary: 不需要鉴权的版本管理接口
tags:
- SysVersion
/sysVersion/importVersion:
post:
consumes:
- application/json
parameters:
- description: 版本JSON数据
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.ImportVersionRequest'
produces:
- application/json
responses:
"200":
description: 导入成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 导入版本数据
tags:
- SysVersion
/system/getServerInfo:
post:
produces:
@@ -5316,7 +5932,7 @@ paths:
- application/json
responses:
"200":
description: 重启系统
description: 重载系统
schema:
allOf:
- $ref: '#/definitions/response.Response'
@@ -5326,7 +5942,7 @@ paths:
type: object
security:
- ApiKeyAuth: []
summary: 重启系统
summary: 重载系统
tags:
- System
/system/setSystemConfig:
@@ -5665,6 +6281,81 @@ paths:
summary: 设置用户信息
tags:
- SysUser
/volcengine/llm/chat:
post:
consumes:
- application/json
parameters:
- description: 聊天请求参数
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.ChatRequest'
produces:
- application/json
responses:
"200":
description: 聊天响应
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.ChatResponse'
type: object
security:
- ApiKeyAuth: []
summary: LLM聊天完成
tags:
- Volcengine
/volcengine/llm/sessions:
get:
produces:
- application/json
responses:
"200":
description: 活跃会话数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: integer
type: object
security:
- ApiKeyAuth: []
summary: 获取活跃会话数量
tags:
- Volcengine
/volcengine/llm/stop:
post:
consumes:
- application/json
parameters:
- description: 停止请求参数
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.StopRequest'
produces:
- application/json
responses:
"200":
description: 停止响应
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.StopResponse'
type: object
security:
- ApiKeyAuth: []
summary: 停止LLM生成
tags:
- Volcengine
securityDefinitions:
ApiKeyAuth:
in: header