| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739 |
- <!DOCTYPE html>
- <html lang="zh-CN">
- <head>
- <meta charset="UTF-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>蜀道安全AI系统 - API接口文档</title>
- <style>
- * { margin: 0; padding: 0; box-sizing: border-box; }
- body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: #fafafa; color: #3b4151; }
- .header { background: linear-gradient(135deg, #1f8a70 0%, #2d5a4a 100%); color: white; padding: 20px 30px; }
- .header h1 { font-size: 28px; margin-bottom: 5px; }
- .header p { opacity: 0.9; font-size: 14px; }
- .container { max-width: 1800px; margin: 0 auto; padding: 20px; }
- .api-grid { display: grid; grid-template-columns: repeat(3, 1fr); gap: 15px; }
- .api-card { background: white; border-radius: 8px; box-shadow: 0 1px 3px rgba(0,0,0,0.12); overflow: hidden; }
- .api-card-header { padding: 12px 15px; display: flex; align-items: center; gap: 10px; border-bottom: 1px solid #eee; }
- .method { padding: 4px 10px; border-radius: 4px; font-size: 11px; font-weight: 700; color: white; text-transform: uppercase; }
- .method.get { background: #61affe; }
- .method.post { background: #49cc90; }
- .api-path { font-family: monospace; font-size: 13px; color: #3b4151; word-break: break-all; }
- .api-card-body { padding: 12px 15px; }
- .api-title { font-size: 14px; font-weight: 600; color: #3b4151; margin-bottom: 8px; }
- .api-desc { font-size: 12px; color: #6b7280; line-height: 1.5; margin-bottom: 10px; }
- .params-title { font-size: 11px; font-weight: 600; color: #1f8a70; margin-bottom: 5px; text-transform: uppercase; }
- .param-item { font-size: 11px; color: #4b5563; padding: 3px 0; border-bottom: 1px dashed #e5e7eb; }
- .param-item:last-child { border-bottom: none; }
- .param-name { font-family: monospace; color: #1f8a70; font-weight: 500; }
- .param-type { color: #9ca3af; font-size: 10px; }
- .section-title { font-size: 18px; font-weight: 600; color: #1f8a70; margin: 25px 0 15px; padding-bottom: 8px; border-bottom: 2px solid #1f8a70; }
- .tag { display: inline-block; padding: 2px 6px; background: #e0f2f1; color: #1f8a70; border-radius: 3px; font-size: 10px; margin-right: 5px; }
- .response-tag { background: #fef3c7; color: #92400e; }
- @media (max-width: 1200px) { .api-grid { grid-template-columns: repeat(2, 1fr); } }
- @media (max-width: 768px) { .api-grid { grid-template-columns: 1fr; } }
- </style>
- </head>
- <body>
- <div class="header">
- <h1>🛡️ 蜀道安全AI系统 API文档</h1>
- <p>ShuDao SafeAI Backend API v1.0 | 基础路径: /apiv1</p>
- </div>
- <div class="container">
- <!-- 认证接口 -->
- <h2 class="section-title">🔐 认证接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/auth/local_login</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">本地登录</div>
- <div class="api-desc">用户名密码登录,返回JWT Token(需配置enable_local_login=true)</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">username</span> <span class="param-type">string</span> - 用户名</div>
- <div class="param-item"><span class="param-name">password</span> <span class="param-type">string</span> - 密码</div>
- <div class="params-title" style="margin-top:8px">响应</div>
- <div class="param-item"><span class="tag response-tag">200</span> token, userInfo</div>
- </div>
- </div>
- </div>
- <!-- AI对话接口 -->
- <h2 class="section-title">💬 AI对话接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/send_deepseek_message</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">发送DeepSeek消息</div>
- <div class="api-desc">发送消息到AI模型,支持安全培训PPT生成、AI写作等业务类型</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
- <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID(可选)</div>
- <div class="param-item"><span class="param-name">business_type</span> <span class="param-type">int</span> - 业务类型(1:安全培训,2:AI写作)</div>
- <div class="param-item"><span class="param-name">exam_name</span> <span class="param-type">string</span> - 考试名称(可选)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/stream/chat</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">流式聊天 (SSE)</div>
- <div class="api-desc">流式输出AI回复,支持RAG检索增强生成</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
- <div class="param-item"><span class="param-name">model</span> <span class="param-type">string</span> - 模型名称(可选)</div>
- <div class="params-title" style="margin-top:8px">响应</div>
- <div class="param-item"><span class="tag">SSE</span> text/event-stream</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/stream/chat-with-db</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">流式聊天(数据库集成)</div>
- <div class="api-desc">流式聊天并自动保存对话记录到数据库</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
- <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
- <div class="param-item"><span class="param-name">business_type</span> <span class="param-type">int</span> - 业务类型</div>
- <div class="param-item"><span class="param-name">online_search_content</span> <span class="param-type">string</span> - 联网搜索内容</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_history_record</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取历史记录</div>
- <div class="api-desc">获取当前用户的AI对话历史记录列表</div>
- <div class="params-title">请求参数</div>
- <div class="param-item">无参数,从Token获取用户ID</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/delete_conversation</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">删除对话</div>
- <div class="api-desc">删除指定的AI对话</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/delete_history_record</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">删除历史记录</div>
- <div class="api-desc">删除指定的历史记录</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint64</span> - 记录ID</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/intent_recognition</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">意图识别</div>
- <div class="api-desc">识别用户输入的意图类型</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_chromadb_document</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取ChromaDB文档</div>
- <div class="api-desc">从向量数据库检索相关文档并生成回答</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">query</span> <span class="param-type">string</span> - 查询内容</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/guess_you_want</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">猜你想问</div>
- <div class="api-desc">根据上下文推荐相关问题</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">context</span> <span class="param-type">string</span> - 上下文内容</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_user_recommend_question</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">用户输入推荐问题</div>
- <div class="api-desc">用户输入时实时返回推荐问题</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">input</span> <span class="param-type">string</span> - 用户输入内容</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/online_search</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">联网搜索</div>
- <div class="api-desc">执行联网搜索获取实时信息</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">query</span> <span class="param-type">string</span> - 搜索关键词</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/save_online_search_result</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">保存联网搜索结果</div>
- <div class="api-desc">将联网搜索结果存入AIMessage表</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 搜索结果内容</div>
- <div class="param-item"><span class="param-name">ai_message_id</span> <span class="param-type">uint64</span> - 消息ID</div>
- </div>
- </div>
- </div>
- <!-- 考试相关接口 -->
- <h2 class="section-title">📝 考试相关接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/exam/build_prompt</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">生成考试提示词</div>
- <div class="api-desc">根据考试配置生成AI提示词</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">exam_config</span> <span class="param-type">object</span> - 考试配置对象</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/exam/build_single_prompt</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">单题生成提示词</div>
- <div class="api-desc">为单个题目重新生成提示词</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">question_type</span> <span class="param-type">string</span> - 题目类型</div>
- <div class="param-item"><span class="param-name">context</span> <span class="param-type">string</span> - 上下文</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/re_modify_question</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">修改考试题目</div>
- <div class="api-desc">修改已生成的考试题目内容</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
- <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 新内容</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/re_produce_single_question</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">重新生成单题</div>
- <div class="api-desc">重新生成指定的单个考试题目</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">question_id</span> <span class="param-type">uint64</span> - 题目ID</div>
- </div>
- </div>
- </div>
- <!-- 隐患识别接口 -->
- <h2 class="section-title">🔍 隐患识别接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/hazard</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">隐患识别</div>
- <div class="api-desc">使用YOLO模型识别图片中的安全隐患,返回标注后的图片</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">scene_name</span> <span class="param-type">string</span> - 场景名称(模型类型)</div>
- <div class="param-item"><span class="param-name">image</span> <span class="param-type">string</span> - 图片OSS链接</div>
- <div class="param-item"><span class="param-name">date</span> <span class="param-type">string</span> - 日期</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/save_step</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">保存步骤</div>
- <div class="api-desc">保存PPT生成步骤、JSON文件和封面图</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
- <div class="param-item"><span class="param-name">step</span> <span class="param-type">int</span> - 步骤编号</div>
- <div class="param-item"><span class="param-name">ppt_json_url</span> <span class="param-type">string</span> - PPT JSON URL</div>
- <div class="param-item"><span class="param-name">cover_image</span> <span class="param-type">string</span> - 封面图URL</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_history_recognition_record</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取识别历史记录</div>
- <div class="api-desc">获取当前用户的隐患识别历史记录</div>
- <div class="params-title">请求参数</div>
- <div class="param-item">无参数,从Token获取用户ID</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_recognition_record_detail</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取识别记录详情</div>
- <div class="api-desc">获取指定识别记录的详细信息</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">recognition_record_id</span> <span class="param-type">int64</span> - 记录ID</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/delete_recognition_record</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">删除识别记录</div>
- <div class="api-desc">删除指定的隐患识别历史记录</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint64</span> - 记录ID</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/submit_evaluation</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">提交点评</div>
- <div class="api-desc">用户对识别结果提交点评反馈</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint</span> - 记录ID</div>
- <div class="param-item"><span class="param-name">scene_match</span> <span class="param-type">int</span> - 场景匹配度</div>
- <div class="param-item"><span class="param-name">tip_accuracy</span> <span class="param-type">int</span> - 提示准确度</div>
- <div class="param-item"><span class="param-name">effect_evaluation</span> <span class="param-type">int</span> - 效果评价</div>
- <div class="param-item"><span class="param-name">user_remark</span> <span class="param-type">string</span> - 用户备注</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_latest_recognition_record</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取最新识别记录</div>
- <div class="api-desc">查询用户最新的一条识别记录是否已点评</div>
- <div class="params-title">请求参数</div>
- <div class="param-item">无参数,从Token获取用户ID</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_third_scene_example_image</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取三级场景示例图</div>
- <div class="api-desc">获取隐患识别三级场景的正确和错误示例图</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">third_scene_name</span> <span class="param-type">string</span> - 三级场景名称</div>
- </div>
- </div>
- </div>
- <!-- OSS文件上传接口 -->
- <h2 class="section-title">📁 OSS文件上传接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/oss/upload</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取上传凭证</div>
- <div class="api-desc">生成S3预签名上传凭证,用于前端直传OSS</div>
- <div class="params-title">响应</div>
- <div class="param-item"><span class="param-name">url</span> - 上传地址</div>
- <div class="param-item"><span class="param-name">fields</span> - 签名字段</div>
- <div class="param-item"><span class="param-name">expire</span> - 过期时间</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/oss/shudao/upload_image</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">上传图片</div>
- <div class="api-desc">上传图片到OSS,自动压缩到200KB以下</div>
- <div class="params-title">请求参数 (FormData)</div>
- <div class="param-item"><span class="param-name">image</span> <span class="param-type">file</span> - 图片文件(≤10MB)</div>
- <div class="params-title" style="margin-top:8px">响应</div>
- <div class="param-item"><span class="param-name">fileUrl</span> - 代理访问URL</div>
- <div class="param-item"><span class="param-name">fileName</span> - 文件名</div>
- <div class="param-item"><span class="param-name">fileSize</span> - 文件大小</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/oss/shudao/upload_json</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">上传PPT JSON文件</div>
- <div class="api-desc">上传PPT配置JSON文件到OSS</div>
- <div class="params-title">请求参数 (FormData)</div>
- <div class="param-item"><span class="param-name">json</span> <span class="param-type">file</span> - JSON文件(≤50MB)</div>
- <div class="params-title" style="margin-top:8px">响应</div>
- <div class="param-item"><span class="param-name">fileUrl</span> - 代理访问URL</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/oss/parse</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">OSS代理解析</div>
- <div class="api-desc">代理转发OSS URL请求,解密并获取文件内容</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">url</span> <span class="param-type">string</span> - 加密的OSS URL</div>
- </div>
- </div>
- </div>
- <!-- 通用功能接口 -->
- <h2 class="section-title">🔧 通用功能接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/recommend_question</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取推荐问题</div>
- <div class="api-desc">随机返回推荐问题列表</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">limit</span> <span class="param-type">int</span> - 数量(默认5)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_function_card</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取功能卡片</div>
- <div class="api-desc">随机返回4条功能卡片</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">function_type</span> <span class="param-type">int</span> - 类型(0:AI问答,1:安全培训)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_hot_question</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取热点问题</div>
- <div class="api-desc">随机返回4条热点问题</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">question_type</span> <span class="param-type">int</span> - 类型(0:AI问答,1:安全培训)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/submit_feedback</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">提交意见反馈</div>
- <div class="api-desc">用户提交意见反馈信息</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 反馈内容</div>
- <div class="param-item"><span class="param-name">contact</span> <span class="param-type">string</span> - 联系方式</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/like_and_dislike</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">点赞/踩</div>
- <div class="api-desc">对AI回复进行点赞或踩的反馈</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint</span> - 消息ID</div>
- <div class="param-item"><span class="param-name">user_feedback</span> <span class="param-type">int</span> - 反馈(1:赞,-1:踩)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_user_data_id</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取用户数据ID</div>
- <div class="api-desc">根据account_id获取用户数据主键ID</div>
- <div class="params-title">请求参数</div>
- <div class="param-item">无参数,从Token获取account_id</div>
- </div>
- </div>
- </div>
- <!-- 政策文件接口 -->
- <h2 class="section-title">📄 政策文件接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_policy_file</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取政策文件列表</div>
- <div class="api-desc">分页获取政策文件列表,支持类型筛选和搜索</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">policy_type</span> <span class="param-type">int</span> - 政策类型(0:全部)</div>
- <div class="param-item"><span class="param-name">search</span> <span class="param-type">string</span> - 搜索关键词</div>
- <div class="param-item"><span class="param-name">page</span> <span class="param-type">int</span> - 页码</div>
- <div class="param-item"><span class="param-name">pageSize</span> <span class="param-type">int</span> - 每页数量</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/download_file</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">下载文件</div>
- <div class="api-desc">从OSS链接下载文件并返回给前端</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">pdf_oss_download_link</span> <span class="param-type">string</span> - OSS下载链接</div>
- <div class="param-item"><span class="param-name">file_name</span> <span class="param-type">string</span> - 自定义文件名(可选)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/policy_file_count</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">政策文件统计</div>
- <div class="api-desc">政策文件查看和下载次数+1</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">policy_file_id</span> <span class="param-type">int</span> - 政策文件ID</div>
- <div class="param-item"><span class="param-name">action_type</span> <span class="param-type">int</span> - 操作类型(1:查看,2:下载)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/get_file_link</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取文件链接</div>
- <div class="api-desc">根据文件名从数据库查找对应的OSS链接</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">file_name</span> <span class="param-type">string</span> - 文件名</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/knowledge/files/advanced-search</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">知识库高级搜索</div>
- <div class="api-desc">从ChromaDB向量数据库进行高级文件搜索</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">query_str</span> <span class="param-type">string</span> - 查询字符串</div>
- <div class="param-item"><span class="param-name">n_results</span> <span class="param-type">int</span> - 结果数量(默认50)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/save_ppt_outline</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">保存PPT大纲</div>
- <div class="api-desc">保存AI生成的PPT大纲内容</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
- <div class="param-item"><span class="param-name">outline</span> <span class="param-type">string</span> - 大纲内容</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/save_edit_document</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">保存编辑文档</div>
- <div class="api-desc">AI写作保存编辑后的文档内容</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">ai_message_id</span> <span class="param-type">uint64</span> - 消息ID</div>
- <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 文档内容</div>
- </div>
- </div>
- </div>
- <!-- 积分系统接口 -->
- <h2 class="section-title">💰 积分系统接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/points/balance</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取积分余额</div>
- <div class="api-desc">获取当前用户的积分余额</div>
- <div class="params-title">请求参数</div>
- <div class="param-item">无参数,从Token获取用户ID</div>
- <div class="params-title" style="margin-top:8px">响应</div>
- <div class="param-item"><span class="param-name">points</span> - 积分余额</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/points/consume</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">消费积分</div>
- <div class="api-desc">消费积分下载文件(每次10积分)</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">file_name</span> <span class="param-type">string</span> - 文件名</div>
- <div class="param-item"><span class="param-name">file_url</span> <span class="param-type">string</span> - 文件URL</div>
- <div class="params-title" style="margin-top:8px">响应</div>
- <div class="param-item"><span class="param-name">new_balance</span> - 新余额</div>
- <div class="param-item"><span class="param-name">points_consumed</span> - 消费积分</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/points/history</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取消费记录</div>
- <div class="api-desc">分页获取用户的积分消费历史记录</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">page</span> <span class="param-type">int</span> - 页码(默认1)</div>
- <div class="param-item"><span class="param-name">pageSize</span> <span class="param-type">int</span> - 每页数量(默认10)</div>
- </div>
- </div>
- </div>
- <!-- 埋点记录接口 -->
- <h2 class="section-title">📊 埋点记录接口</h2>
- <div class="api-grid">
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/tracking/record</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">记录埋点数据</div>
- <div class="api-desc">记录用户行为埋点数据</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">api_path</span> <span class="param-type">string</span> - 接口路径</div>
- <div class="param-item"><span class="param-name">method</span> <span class="param-type">string</span> - 请求方法</div>
- <div class="param-item"><span class="param-name">extra_data</span> <span class="param-type">string</span> - 额外数据(可选)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/tracking/records</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取埋点记录</div>
- <div class="api-desc">分页获取埋点记录列表</div>
- <div class="params-title">请求参数 (Query)</div>
- <div class="param-item"><span class="param-name">user_id</span> <span class="param-type">int</span> - 用户ID(可选)</div>
- <div class="param-item"><span class="param-name">api_path</span> <span class="param-type">string</span> - 接口路径(可选)</div>
- <div class="param-item"><span class="param-name">page</span> <span class="param-type">int</span> - 页码(默认1)</div>
- <div class="param-item"><span class="param-name">page_size</span> <span class="param-type">int</span> - 每页数量(默认20)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method post">POST</span>
- <span class="api-path">/apiv1/tracking/api_mapping</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">添加接口映射</div>
- <div class="api-desc">添加接口路径到名称的映射关系</div>
- <div class="params-title">请求参数 (Body JSON)</div>
- <div class="param-item"><span class="param-name">api_path</span> <span class="param-type">string</span> - 接口路径</div>
- <div class="param-item"><span class="param-name">api_name</span> <span class="param-type">string</span> - 接口名称</div>
- <div class="param-item"><span class="param-name">api_desc</span> <span class="param-type">string</span> - 接口描述(可选)</div>
- </div>
- </div>
- <div class="api-card">
- <div class="api-card-header">
- <span class="method get">GET</span>
- <span class="api-path">/apiv1/tracking/api_mappings</span>
- </div>
- <div class="api-card-body">
- <div class="api-title">获取接口映射列表</div>
- <div class="api-desc">获取所有接口路径映射关系</div>
- <div class="params-title">请求参数</div>
- <div class="param-item">无参数</div>
- </div>
- </div>
- </div>
- <div style="text-align:center; padding:30px; color:#9ca3af; font-size:12px;">
- <p>蜀道安全AI系统 API文档 v1.0 | 共 <strong>45</strong> 个接口</p>
- <p>基础路径: <code>/apiv1</code> | 认证方式: JWT Token (Header: Authorization)</p>
- <p>生成时间: 2024年12月</p>
- </div>
- </div>
- </body>
- </html>
|