430 lines
17 KiB
Go
430 lines
17 KiB
Go
package v1
|
||
|
||
import (
|
||
"github.com/gogf/gf/v2/frame/g"
|
||
"github.com/gogf/gf/v2/os/gtime"
|
||
)
|
||
|
||
// ============================================================
|
||
// 开放平台业务 API（第三方应用调用）
|
||
// ============================================================
|
||
|
||
// OpenMemberList 成员列表
|
||
type OpenMemberListReq struct {
|
||
g.Meta `path:"/v1/members" method:"get" tags:"开放平台API" summary:"成员列表"`
|
||
Page int `json:"page" in:"query" d:"1" dc:"页码"`
|
||
PageSize int `json:"page_size" in:"query" d:"20" dc:"每页数量"`
|
||
Keyword string `json:"keyword" in:"query" dc:"搜索关键词"`
|
||
Role string `json:"role" in:"query" dc:"按角色筛选"`
|
||
Status string `json:"status" in:"query" dc:"按状态筛选"`
|
||
}
|
||
|
||
type OpenMemberListRes struct {
|
||
List []OpenMemberItem `json:"list"`
|
||
Total int `json:"total"`
|
||
Page int `json:"page"`
|
||
PageSize int `json:"page_size"`
|
||
}
|
||
|
||
type OpenMemberItem struct {
|
||
ID int64 `json:"id"`
|
||
Username string `json:"username"`
|
||
Email string `json:"email"`
|
||
Role string `json:"role"`
|
||
Status string `json:"status"`
|
||
CreatedAt string `json:"created_at"`
|
||
}
|
||
|
||
// OpenMemberCreate 创建成员
|
||
type OpenMemberCreateReq struct {
|
||
g.Meta `path:"/v1/members" method:"post" mime:"json" tags:"开放平台API" summary:"创建成员"`
|
||
Username string `json:"username" v:"required|length:2,50#请输入用户名|用户名长度2-50" dc:"用户名"`
|
||
Email string `json:"email" v:"required|email#请输入邮箱|邮箱格式不正确" dc:"邮箱"`
|
||
Password string `json:"password" v:"required|length:8,64#请输入密码|密码长度6-50" dc:"密码"`
|
||
Role string `json:"role" v:"required|in:admin,member#请选择角色|角色无效" dc:"角色"`
|
||
DisplayName string `json:"display_name" dc:"显示名称"`
|
||
}
|
||
|
||
type OpenMemberCreateRes struct {
|
||
ID int64 `json:"id"`
|
||
}
|
||
|
||
// OpenMemberUpdate 更新成员
|
||
type OpenMemberUpdateReq struct {
|
||
g.Meta `path:"/v1/members/{id}" method:"put" mime:"json" tags:"开放平台API" summary:"更新成员"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定成员ID" dc:"成员ID"`
|
||
Role *string `json:"role" v:"in:admin,member#角色无效" dc:"角色"`
|
||
DisplayName *string `json:"display_name" dc:"显示名称"`
|
||
Status *string `json:"status" v:"in:active,disabled#状态无效" dc:"状态"`
|
||
}
|
||
|
||
type OpenMemberUpdateRes struct{}
|
||
|
||
// OpenMemberDelete 删除成员
|
||
type OpenMemberDeleteReq struct {
|
||
g.Meta `path:"/v1/members/{id}" method:"delete" tags:"开放平台API" summary:"删除成员"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定成员ID" dc:"成员ID"`
|
||
}
|
||
|
||
type OpenMemberDeleteRes struct{}
|
||
|
||
// OpenMemberQuota 成员额度查询
|
||
type OpenMemberQuotaReq struct {
|
||
g.Meta `path:"/v1/members/{id}/quota" method:"get" tags:"开放平台API" summary:"成员额度查询"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定成员ID" dc:"成员ID"`
|
||
}
|
||
|
||
type OpenMemberQuotaRes struct {
|
||
QuotaType string `json:"quota_type"`
|
||
QuotaLimit float64 `json:"quota_limit"`
|
||
QuotaUsed float64 `json:"quota_used"`
|
||
Period string `json:"period"`
|
||
}
|
||
|
||
// OpenMemberQuotaUpdate 更新成员额度
|
||
type OpenMemberQuotaUpdateReq struct {
|
||
g.Meta `path:"/v1/members/{id}/quota" method:"put" mime:"json" tags:"开放平台API" summary:"更新成员额度"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定成员ID" dc:"成员ID"`
|
||
QuotaType string `json:"quota_type" v:"required|in:none,total,periodic#请选择额度类型|额度类型无效" dc:"额度类型"`
|
||
QuotaLimit float64 `json:"quota_limit" v:"min:0" dc:"额度上限(USD)"`
|
||
Period string `json:"period" v:"in:day,week,month" dc:"周期类型"`
|
||
}
|
||
|
||
type OpenMemberQuotaUpdateRes struct{}
|
||
|
||
// OpenMemberModels 成员可用模型
|
||
type OpenMemberModelsReq struct {
|
||
g.Meta `path:"/v1/members/{id}/models" method:"get" tags:"开放平台API" summary:"成员可用模型列表"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定成员ID" dc:"成员ID"`
|
||
}
|
||
|
||
type OpenMemberModelsRes struct {
|
||
List []string `json:"list"`
|
||
}
|
||
|
||
// OpenMemberModelsUpdate 更新成员可用模型
|
||
type OpenMemberModelsUpdateReq struct {
|
||
g.Meta `path:"/v1/members/{id}/models" method:"put" mime:"json" tags:"开放平台API" summary:"更新成员可用模型"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定成员ID" dc:"成员ID"`
|
||
ModelIDs []int64 `json:"model_ids" v:"required#请选择模型列表" dc:"模型ID列表"`
|
||
}
|
||
|
||
type OpenMemberModelsUpdateRes struct{}
|
||
|
||
// ============================================================
|
||
// API Key 管理
|
||
// ============================================================
|
||
|
||
// OpenKeyList API Key 列表
|
||
type OpenKeyListReq struct {
|
||
g.Meta `path:"/v1/keys" method:"get" tags:"开放平台API" summary:"API Key列表"`
|
||
Page int `json:"page" in:"query" d:"1" dc:"页码"`
|
||
PageSize int `json:"page_size" in:"query" d:"20" dc:"每页数量"`
|
||
Status string `json:"status" in:"query" dc:"按状态筛选"`
|
||
}
|
||
|
||
type OpenKeyListRes struct {
|
||
List []OpenKeyItem `json:"list"`
|
||
Total int `json:"total"`
|
||
Page int `json:"page"`
|
||
PageSize int `json:"page_size"`
|
||
}
|
||
|
||
type OpenKeyItem struct {
|
||
ID int64 `json:"id"`
|
||
Name string `json:"name"`
|
||
Key string `json:"key"` // 脱敏显示 sk-***xxx
|
||
Status string `json:"status"`
|
||
CreatedAt string `json:"created_at"`
|
||
}
|
||
|
||
// OpenKeyCreate 创建 API Key
|
||
type OpenKeyCreateReq struct {
|
||
g.Meta `path:"/v1/keys" method:"post" mime:"json" tags:"开放平台API" summary:"创建API Key"`
|
||
Name string `json:"name" v:"required|length:2,100#请输入Key名称|名称长度2-100" dc:"Key名称"`
|
||
ProjectID int64 `json:"project_id" dc:"关联项目 ID（可选；填写后该 Key 随项目归档一并失效）"`
|
||
Scope string `json:"scope" d:"full" v:"in:full,chat_only,embeddings_only,images_only,read_only#权限范围无效" dc:"权限范围"`
|
||
ModelScopes []string `json:"model_scopes" dc:"可用模型列表（为空则不限）"`
|
||
QuotaLimit float64 `json:"quota_limit" d:"0" dc:"额度上限（0=不限）"`
|
||
}
|
||
|
||
type OpenKeyCreateRes struct {
|
||
ID int64 `json:"id"`
|
||
Key string `json:"key"` // 完整 Key，仅创建时返回
|
||
}
|
||
|
||
// OpenKeyDelete 删除 API Key
|
||
type OpenKeyDeleteReq struct {
|
||
g.Meta `path:"/v1/keys/{id}" method:"delete" tags:"开放平台API" summary:"删除API Key"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定Key ID" dc:"Key ID"`
|
||
}
|
||
|
||
type OpenKeyDeleteRes struct{}
|
||
|
||
// ============================================================
|
||
// 用量查询
|
||
// ============================================================
|
||
|
||
// OpenUsageQuery 用量查询
|
||
type OpenUsageQueryReq struct {
|
||
g.Meta `path:"/v1/usage" method:"get" tags:"开放平台API" summary:"用量查询"`
|
||
StartDate string `json:"start_date" in:"query" v:"required#请输入开始日期" dc:"开始日期 (YYYY-MM-DD)"`
|
||
EndDate string `json:"end_date" in:"query" v:"required#请输入结束日期" dc:"结束日期 (YYYY-MM-DD)"`
|
||
GroupBy string `json:"group_by" in:"query" d:"day" v:"in:day,model,key#分组方式无效" dc:"分组方式: day/model/key"`
|
||
Page int `json:"page" in:"query" d:"1" dc:"页码"`
|
||
PageSize int `json:"page_size" in:"query" d:"20" dc:"每页数量"`
|
||
}
|
||
|
||
type OpenUsageQueryRes struct {
|
||
List []OpenUsageItem `json:"list"`
|
||
Total int `json:"total"`
|
||
Page int `json:"page"`
|
||
PageSize int `json:"page_size"`
|
||
}
|
||
|
||
type OpenUsageItem struct {
|
||
Date string `json:"date"`
|
||
Model string `json:"model,omitempty"`
|
||
KeyName string `json:"key_name,omitempty"`
|
||
RequestCount int64 `json:"request_count"`
|
||
PromptTokens int64 `json:"prompt_tokens"`
|
||
CompletionTokens int64 `json:"completion_tokens"`
|
||
TotalTokens int64 `json:"total_tokens"`
|
||
Cost string `json:"cost"`
|
||
}
|
||
|
||
// ============================================================
|
||
// 费用查询
|
||
// ============================================================
|
||
|
||
// OpenBillingQuery 费用查询
|
||
type OpenBillingQueryReq struct {
|
||
g.Meta `path:"/v1/billing" method:"get" tags:"开放平台API" summary:"费用查询"`
|
||
StartDate string `json:"start_date" in:"query" v:"required#请输入开始日期" dc:"开始日期 (YYYY-MM-DD)"`
|
||
EndDate string `json:"end_date" in:"query" v:"required#请输入结束日期" dc:"结束日期 (YYYY-MM-DD)"`
|
||
Page int `json:"page" in:"query" d:"1" dc:"页码"`
|
||
PageSize int `json:"page_size" in:"query" d:"20" dc:"每页数量"`
|
||
}
|
||
|
||
type OpenBillingQueryRes struct {
|
||
List []OpenBillingItem `json:"list"`
|
||
Total int `json:"total"`
|
||
Page int `json:"page"`
|
||
PageSize int `json:"page_size"`
|
||
}
|
||
|
||
type OpenBillingItem struct {
|
||
ID int64 `json:"id"`
|
||
Type string `json:"type"`
|
||
Amount string `json:"amount"`
|
||
Balance string `json:"balance,omitempty"`
|
||
Description string `json:"description"`
|
||
CreatedAt string `json:"created_at"`
|
||
}
|
||
|
||
// ============================================================
|
||
// 项目管理
|
||
// ============================================================
|
||
|
||
// OpenProjectList 项目列表
|
||
type OpenProjectListReq struct {
|
||
g.Meta `path:"/v1/projects" method:"get" tags:"开放平台API" summary:"项目列表"`
|
||
Page int `json:"page" in:"query" d:"1" dc:"页码"`
|
||
PageSize int `json:"page_size" in:"query" d:"20" dc:"每页数量"`
|
||
Status string `json:"status" in:"query" dc:"按状态筛选：active/archived/budget_exhausted"`
|
||
Keyword string `json:"keyword" in:"query" dc:"搜索关键词"`
|
||
}
|
||
|
||
type OpenProjectListRes struct {
|
||
List []OpenProjectItem `json:"list"`
|
||
Total int `json:"total"`
|
||
Page int `json:"page"`
|
||
PageSize int `json:"page_size"`
|
||
}
|
||
|
||
type OpenProjectItem struct {
|
||
ID int64 `json:"id"`
|
||
Name string `json:"name"`
|
||
Description string `json:"description"`
|
||
Status string `json:"status"`
|
||
Budget string `json:"budget"` // USD 6位小数，"unlimited" 表示不限
|
||
CreatedAt string `json:"created_at"`
|
||
UpdatedAt string `json:"updated_at"`
|
||
}
|
||
|
||
// OpenProjectCreate 创建项目
|
||
type OpenProjectCreateReq struct {
|
||
g.Meta `path:"/v1/projects" method:"post" mime:"json" tags:"开放平台API" summary:"创建项目"`
|
||
Name string `json:"name" v:"required|length:1,100#请输入项目名称|项目名称长度1-100" dc:"项目名称"`
|
||
Description string `json:"description" dc:"项目描述"`
|
||
Budget float64 `json:"budget" dc:"项目预算上限(USD，0=不限)"`
|
||
}
|
||
|
||
type OpenProjectCreateRes struct {
|
||
ID int64 `json:"id"`
|
||
}
|
||
|
||
// OpenProjectGet 项目详情
|
||
type OpenProjectGetReq struct {
|
||
g.Meta `path:"/v1/projects/{id}" method:"get" tags:"开放平台API" summary:"项目详情"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
}
|
||
|
||
type OpenProjectGetRes struct {
|
||
ID int64 `json:"id"`
|
||
Name string `json:"name"`
|
||
Description string `json:"description"`
|
||
Status string `json:"status"`
|
||
Budget string `json:"budget"`
|
||
ActiveKeys int `json:"active_keys"`
|
||
TotalKeys int `json:"total_keys"`
|
||
MonthCost string `json:"month_cost"`
|
||
MonthRequests int64 `json:"month_requests"`
|
||
CreatedAt string `json:"created_at"`
|
||
UpdatedAt string `json:"updated_at"`
|
||
}
|
||
|
||
// OpenProjectUpdate 更新项目
|
||
type OpenProjectUpdateReq struct {
|
||
g.Meta `path:"/v1/projects/{id}" method:"put" mime:"json" tags:"开放平台API" summary:"更新项目"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
Name *string `json:"name" dc:"项目名称"`
|
||
Description *string `json:"description" dc:"项目描述"`
|
||
Budget *float64 `json:"budget" dc:"项目预算上限(USD，0=不限)"`
|
||
}
|
||
|
||
type OpenProjectUpdateRes struct{}
|
||
|
||
// OpenProjectArchive 归档项目
|
||
type OpenProjectArchiveReq struct {
|
||
g.Meta `path:"/v1/projects/{id}/archive" method:"post" mime:"json" tags:"开放平台API" summary:"归档项目"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
}
|
||
|
||
type OpenProjectArchiveRes struct{}
|
||
|
||
// OpenProjectUnarchive 取消归档
|
||
type OpenProjectUnarchiveReq struct {
|
||
g.Meta `path:"/v1/projects/{id}/unarchive" method:"post" mime:"json" tags:"开放平台API" summary:"取消归档"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
}
|
||
|
||
type OpenProjectUnarchiveRes struct{}
|
||
|
||
// ============================================================
|
||
// 项目 API Key 管理
|
||
// ============================================================
|
||
|
||
// OpenProjectKeyList 项目密钥列表
|
||
type OpenProjectKeyListReq struct {
|
||
g.Meta `path:"/v1/projects/{id}/api-keys" method:"get" tags:"开放平台API" summary:"项目密钥列表"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
Page int `json:"page" in:"query" d:"1" dc:"页码"`
|
||
PageSize int `json:"page_size" in:"query" d:"20" dc:"每页数量"`
|
||
}
|
||
|
||
type OpenProjectKeyListRes struct {
|
||
List []OpenProjectKeyItem `json:"list"`
|
||
Total int `json:"total"`
|
||
Page int `json:"page"`
|
||
PageSize int `json:"page_size"`
|
||
}
|
||
|
||
type OpenProjectKeyItem struct {
|
||
ID int64 `json:"id"`
|
||
Name string `json:"name"`
|
||
KeyPrefix string `json:"key_prefix"`
|
||
Status string `json:"status"`
|
||
CreatedAt string `json:"created_at"`
|
||
ExpiresAt string `json:"expires_at,omitempty"`
|
||
}
|
||
|
||
// OpenProjectKeyCreate 创建项目密钥
|
||
type OpenProjectKeyCreateReq struct {
|
||
g.Meta `path:"/v1/projects/{id}/api-keys" method:"post" mime:"json" tags:"开放平台API" summary:"创建项目密钥"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
Name string `json:"name" v:"required|length:1,100#请输入Key名称|名称长度1-100" dc:"Key名称"`
|
||
Scope string `json:"scope" d:"full" v:"in:full,chat_only,embeddings_only,images_only,read_only#权限范围无效" dc:"权限范围"`
|
||
ExpiresAt *gtime.Time `json:"expires_at" dc:"过期时间"`
|
||
ModelNames []string `json:"model_names" dc:"可用模型列表"`
|
||
}
|
||
|
||
type OpenProjectKeyCreateRes struct {
|
||
ID int64 `json:"id"`
|
||
Name string `json:"name"`
|
||
Key string `json:"key"`
|
||
KeyPrefix string `json:"key_prefix"`
|
||
}
|
||
|
||
// OpenProjectKeyDelete 删除项目密钥
|
||
type OpenProjectKeyDeleteReq struct {
|
||
g.Meta `path:"/v1/projects/{id}/api-keys/{keyId}" method:"delete" tags:"开放平台API" summary:"删除项目密钥"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
KeyId int64 `json:"keyId" in:"path" v:"required#请指定密钥ID" dc:"密钥ID"`
|
||
}
|
||
|
||
type OpenProjectKeyDeleteRes struct{}
|
||
|
||
// ============================================================
|
||
// 项目用量查询
|
||
// ============================================================
|
||
|
||
// OpenProjectUsageStats 项目用量统计
|
||
type OpenProjectUsageStatsReq struct {
|
||
g.Meta `path:"/v1/projects/{id}/usage-stats" method:"get" tags:"开放平台API" summary:"项目用量统计"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
StartDate string `json:"start_date" in:"query" dc:"开始日期 (YYYY-MM-DD)，默认近30天"`
|
||
EndDate string `json:"end_date" in:"query" dc:"结束日期 (YYYY-MM-DD)"`
|
||
}
|
||
|
||
type OpenProjectUsageStatsRes struct {
|
||
TotalCost string `json:"total_cost"`
|
||
TotalRequests int64 `json:"total_requests"`
|
||
TotalInputTokens int64 `json:"total_input_tokens"`
|
||
TotalOutputTokens int64 `json:"total_output_tokens"`
|
||
Daily []OpenProjectDailyStat `json:"daily"`
|
||
Models []OpenProjectModelStat `json:"models"`
|
||
}
|
||
|
||
type OpenProjectDailyStat struct {
|
||
Date string `json:"date"`
|
||
RequestCount int64 `json:"request_count"`
|
||
TotalCost string `json:"total_cost"`
|
||
InputTokens int64 `json:"input_tokens"`
|
||
OutputTokens int64 `json:"output_tokens"`
|
||
}
|
||
|
||
type OpenProjectModelStat struct {
|
||
ModelName string `json:"model_name"`
|
||
RequestCount int64 `json:"request_count"`
|
||
TotalCost string `json:"total_cost"`
|
||
}
|
||
|
||
// OpenProjectUsageLogs 项目用量日志
|
||
type OpenProjectUsageLogsReq struct {
|
||
g.Meta `path:"/v1/projects/{id}/usage-logs" method:"get" tags:"开放平台API" summary:"项目用量日志"`
|
||
Id int64 `json:"id" in:"path" v:"required#请指定项目ID" dc:"项目ID"`
|
||
Page int `json:"page" in:"query" d:"1" dc:"页码"`
|
||
PageSize int `json:"page_size" in:"query" d:"20" dc:"每页数量"`
|
||
}
|
||
|
||
type OpenProjectUsageLogsRes struct {
|
||
List []OpenProjectUsageLogItem `json:"list"`
|
||
Total int `json:"total"`
|
||
Page int `json:"page"`
|
||
PageSize int `json:"page_size"`
|
||
}
|
||
|
||
type OpenProjectUsageLogItem struct {
|
||
ID int64 `json:"id"`
|
||
ModelName string `json:"model_name"`
|
||
RelayMode string `json:"relay_mode"`
|
||
InputTokens int `json:"input_tokens"`
|
||
OutputTokens int `json:"output_tokens"`
|
||
TotalCost string `json:"total_cost"`
|
||
LatencyMs int `json:"latency_ms"`
|
||
Status string `json:"status"`
|
||
ErrorMessage string `json:"error_message,omitempty"`
|
||
CreatedAt string `json:"created_at"`
|
||
}
|