Skip to content

数据模型与接口速查


数据模型

AI 模块表定义在 packages/server/src/db/schema/ai.ts

枚举

枚举说明
ai_provideropenai_compatible / anthropic / gemini / baiduAI 供应商类型
ai_message_rolesystem / user / assistant消息角色
ai_feedback_statuspending / resolved / ignored反馈处理状态
ai_prompt_scopesystem / user提示词模板范围
ai_agent_statusprivate / pending / published / rejected智能体发布状态

表结构速查

关键字段说明
ai_provider_configsproviderbase_urlapi_key(加密)、modelmodelscapabilitiesprice_input_per_mprice_output_per_mfallback_config_idmax_concurrentis_defaultis_enabled系统级 AI 服务商配置
ai_conversationsuser_idtitleprovider_snapshotis_archivedis_pinnedsystem_prompt_overrideknowledge_base_idagent_idtagsactive_leaf_msg_id用户 AI 对话主表
ai_messagesconversation_idparent_id(分支树)、rolecontentreasoningmodeltokens_input/outputttft_msduration_msfeedback*trace对话消息、反馈与调用链
user_ai_configsuser_idproviderbase_urlapi_keymodeltemperaturemax_tokenssystem_promptis_enabled用户个人 AI 配置
ai_prompt_templatesnamecontentcategoryscopeuser_idis_builtinsortusage_countis_enabled提示词模板
ai_prompt_template_versionstemplate_idversionnamecontentcreated_by模板历史版本快照
ai_user_preferencesuser_id(唯一)、about_mereply_styleis_enabled个人指令(Custom Instructions)
ai_shared_conversationstoken(唯一)、conversation_iduser_idexpires_at对话分享链接
ai_arena_votesuser_idquestionmodel_amodel_bwinner模型对比投票
ai_knowledge_basesnameuser_idembedding_model个人知识库
ai_kb_documentskb_idnamesource_urlstatuschunk_countchar_count知识库文档
ai_kb_chunkskb_iddoc_idcontentembedding(real[])、embedding_vec(pgvector,条件迁移)知识库分块
ai_agentsuser_idnameavatarsystem_promptconfig_idmodelknowledge_base_idtoolsopening_messagesuggested_questionsstatususage_count自定义智能体
ai_http_toolsname(唯一)、descriptionmethodurl_templateheadersparamsis_enabledHTTP API 工具
ai_eval_setsnameitems(问题 + 期望要点)评测集
ai_eval_runsset_idconfig_idmodelstatusresultsavg_duration_mstotal_tokens评测运行记录

对外时间字段通过 formatDateTime / formatNullableDateTime 输出,格式为 YYYY-MM-DD HH:mm:ss

Redis Key

Key说明
ai:quota:{userId}:{date}每日 token 配额计数
ai:req:{date} / ai:err:{date}请求 / 失败按日计数(成功率,保留 40 天)
ai:gen:{genId}:events / :meta / :cancel生成缓冲(SSE 断线续传,TTL 10min)
ai:gen:active:{conversationId}会话进行中的生成任务指针

接口一览

所有 AI 接口均挂载到 /api/ai/*。各子域接口详表见对应文档页,此处为挂载点速查:

挂载点说明详见
/api/ai/conversations对话 / 消息 / 聊天流 / 分支 / 标签 / 分享 / 知识库挂载智能对话
/api/ai/generations生成恢复流与停止智能对话
/api/ai/agents智能体 CRUD / 上架审核 / 市场 / 克隆自定义智能体
/api/ai/providers/api/ai/models/api/ai/user-configs服务商与个人配置服务商与个人配置
/api/ai/knowledge-bases知识库与文档知识库 RAG
/api/ai/http-toolsHTTP 工具工具与函数调用
/api/ai/prompt-templates提示词模板与版本提示词模板
/api/ai/usage/api/ai/audit/api/ai/eval统计 / 审计 / 评测运营与治理
/api/ai/preferences个人指令智能对话
/api/ai/arena模型对比(Arena)智能对话
/api/ai/public分享只读页(免登录)安全与合规

对话与消息接口详表

方法路径说明权限
GET/api/ai/conversations对话列表(archived / keyword / tag / limit / offset登录用户
POST/api/ai/conversations新建对话(可带 agentId登录用户
GET/api/ai/conversations/{id}对话详情登录用户
DELETE/api/ai/conversations/{id}删除对话登录用户
GET/api/ai/conversations/{id}/messages消息历史(含分支树 parentId登录用户
POST/api/ai/conversations/{id}/chatSSE 流式对话登录用户
GET/api/ai/conversations/{id}/active-generation进行中的生成任务登录用户
GET/api/ai/generations/{genId}/stream生成恢复流(断线续传)登录用户
POST/api/ai/generations/{genId}/cancel停止生成登录用户
PUT/api/ai/conversations/{id}/rename重命名登录用户
PUT/api/ai/conversations/{id}/pin置顶 / 取消置顶登录用户
PUT/api/ai/conversations/{id}/archive归档 / 取消归档登录用户
PUT/api/ai/conversations/{id}/tags更新标签登录用户
PUT/api/ai/conversations/{id}/active-branch切换消息分支登录用户
PUT/api/ai/conversations/{id}/system-prompt设置对话级提示词登录用户
PUT/api/ai/conversations/{id}/knowledge-base挂载 / 取消挂载知识库登录用户
GET/POST/DELETE/api/ai/conversations/{id}/share查询 / 生成 / 撤销分享登录用户
GET/api/ai/conversations/{id}/export导出 Markdown / JSON(激活分支)登录用户
DELETE/api/ai/conversations/{id}/messages/{msgId}/cascade删除消息子树登录用户
PUT/api/ai/conversations/{id}/messages/{msgId}/feedback点赞 / 点踩反馈登录用户
GET/api/ai/conversations/admin/feedback管理员反馈列表ai:feedback:view
PUT/api/ai/conversations/admin/feedback/{msgId}管理员处理反馈ai:feedback:handle

前端页面

页面路由说明
智能对话/ai/chat多轮对话、分支树、断线续传、模型选择、角色、知识库、图片、语音、Arena、个人指令、分享
智能体/ai/agents我的智能体 / 市场 / 上架审核
AI 服务商/ai/providers系统级服务商配置、多模型、可靠性、连接测试
AI 反馈/ai/feedback反馈筛选、上下文回放、处理与导出
对话审计/ai/audit跨用户消息检索、上下文回放、Trace 调用链
知识库/ai/knowledge知识库 CRUD、文档 / URL 入库、检索方式展示
AI 工具/ai/toolsHTTP API 工具管理
提示词模板/ai/prompts模板 CRUD、变量占位符、版本历史
模型评测/ai/eval评测集维护、异步运行、结果对比
用量统计/ai/usage概览卡片、趋势图、模型统计、用户 Top 10
分享只读页/public/ai-chat/{token}免登录只读对话回放

Built with VitePress for local documentation preview.