api-docs.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739
  1. <!DOCTYPE html>
  2. <html lang="zh-CN">
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <title>蜀道安全AI系统 - API接口文档</title>
  7. <style>
  8. * { margin: 0; padding: 0; box-sizing: border-box; }
  9. body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: #fafafa; color: #3b4151; }
  10. .header { background: linear-gradient(135deg, #1f8a70 0%, #2d5a4a 100%); color: white; padding: 20px 30px; }
  11. .header h1 { font-size: 28px; margin-bottom: 5px; }
  12. .header p { opacity: 0.9; font-size: 14px; }
  13. .container { max-width: 1800px; margin: 0 auto; padding: 20px; }
  14. .api-grid { display: grid; grid-template-columns: repeat(3, 1fr); gap: 15px; }
  15. .api-card { background: white; border-radius: 8px; box-shadow: 0 1px 3px rgba(0,0,0,0.12); overflow: hidden; }
  16. .api-card-header { padding: 12px 15px; display: flex; align-items: center; gap: 10px; border-bottom: 1px solid #eee; }
  17. .method { padding: 4px 10px; border-radius: 4px; font-size: 11px; font-weight: 700; color: white; text-transform: uppercase; }
  18. .method.get { background: #61affe; }
  19. .method.post { background: #49cc90; }
  20. .api-path { font-family: monospace; font-size: 13px; color: #3b4151; word-break: break-all; }
  21. .api-card-body { padding: 12px 15px; }
  22. .api-title { font-size: 14px; font-weight: 600; color: #3b4151; margin-bottom: 8px; }
  23. .api-desc { font-size: 12px; color: #6b7280; line-height: 1.5; margin-bottom: 10px; }
  24. .params-title { font-size: 11px; font-weight: 600; color: #1f8a70; margin-bottom: 5px; text-transform: uppercase; }
  25. .param-item { font-size: 11px; color: #4b5563; padding: 3px 0; border-bottom: 1px dashed #e5e7eb; }
  26. .param-item:last-child { border-bottom: none; }
  27. .param-name { font-family: monospace; color: #1f8a70; font-weight: 500; }
  28. .param-type { color: #9ca3af; font-size: 10px; }
  29. .section-title { font-size: 18px; font-weight: 600; color: #1f8a70; margin: 25px 0 15px; padding-bottom: 8px; border-bottom: 2px solid #1f8a70; }
  30. .tag { display: inline-block; padding: 2px 6px; background: #e0f2f1; color: #1f8a70; border-radius: 3px; font-size: 10px; margin-right: 5px; }
  31. .response-tag { background: #fef3c7; color: #92400e; }
  32. @media (max-width: 1200px) { .api-grid { grid-template-columns: repeat(2, 1fr); } }
  33. @media (max-width: 768px) { .api-grid { grid-template-columns: 1fr; } }
  34. </style>
  35. </head>
  36. <body>
  37. <div class="header">
  38. <h1>🛡️ 蜀道安全AI系统 API文档</h1>
  39. <p>ShuDao SafeAI Backend API v1.0 | 基础路径: /apiv1</p>
  40. </div>
  41. <div class="container">
  42. <!-- 认证接口 -->
  43. <h2 class="section-title">🔐 认证接口</h2>
  44. <div class="api-grid">
  45. <div class="api-card">
  46. <div class="api-card-header">
  47. <span class="method post">POST</span>
  48. <span class="api-path">/apiv1/auth/local_login</span>
  49. </div>
  50. <div class="api-card-body">
  51. <div class="api-title">本地登录</div>
  52. <div class="api-desc">用户名密码登录,返回JWT Token(需配置enable_local_login=true)</div>
  53. <div class="params-title">请求参数 (Body JSON)</div>
  54. <div class="param-item"><span class="param-name">username</span> <span class="param-type">string</span> - 用户名</div>
  55. <div class="param-item"><span class="param-name">password</span> <span class="param-type">string</span> - 密码</div>
  56. <div class="params-title" style="margin-top:8px">响应</div>
  57. <div class="param-item"><span class="tag response-tag">200</span> token, userInfo</div>
  58. </div>
  59. </div>
  60. </div>
  61. <!-- AI对话接口 -->
  62. <h2 class="section-title">💬 AI对话接口</h2>
  63. <div class="api-grid">
  64. <div class="api-card">
  65. <div class="api-card-header">
  66. <span class="method post">POST</span>
  67. <span class="api-path">/apiv1/send_deepseek_message</span>
  68. </div>
  69. <div class="api-card-body">
  70. <div class="api-title">发送DeepSeek消息</div>
  71. <div class="api-desc">发送消息到AI模型,支持安全培训PPT生成、AI写作等业务类型</div>
  72. <div class="params-title">请求参数 (Body JSON)</div>
  73. <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
  74. <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID(可选)</div>
  75. <div class="param-item"><span class="param-name">business_type</span> <span class="param-type">int</span> - 业务类型(1:安全培训,2:AI写作)</div>
  76. <div class="param-item"><span class="param-name">exam_name</span> <span class="param-type">string</span> - 考试名称(可选)</div>
  77. </div>
  78. </div>
  79. <div class="api-card">
  80. <div class="api-card-header">
  81. <span class="method post">POST</span>
  82. <span class="api-path">/apiv1/stream/chat</span>
  83. </div>
  84. <div class="api-card-body">
  85. <div class="api-title">流式聊天 (SSE)</div>
  86. <div class="api-desc">流式输出AI回复,支持RAG检索增强生成</div>
  87. <div class="params-title">请求参数 (Body JSON)</div>
  88. <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
  89. <div class="param-item"><span class="param-name">model</span> <span class="param-type">string</span> - 模型名称(可选)</div>
  90. <div class="params-title" style="margin-top:8px">响应</div>
  91. <div class="param-item"><span class="tag">SSE</span> text/event-stream</div>
  92. </div>
  93. </div>
  94. <div class="api-card">
  95. <div class="api-card-header">
  96. <span class="method post">POST</span>
  97. <span class="api-path">/apiv1/stream/chat-with-db</span>
  98. </div>
  99. <div class="api-card-body">
  100. <div class="api-title">流式聊天(数据库集成)</div>
  101. <div class="api-desc">流式聊天并自动保存对话记录到数据库</div>
  102. <div class="params-title">请求参数 (Body JSON)</div>
  103. <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
  104. <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
  105. <div class="param-item"><span class="param-name">business_type</span> <span class="param-type">int</span> - 业务类型</div>
  106. <div class="param-item"><span class="param-name">online_search_content</span> <span class="param-type">string</span> - 联网搜索内容</div>
  107. </div>
  108. </div>
  109. <div class="api-card">
  110. <div class="api-card-header">
  111. <span class="method get">GET</span>
  112. <span class="api-path">/apiv1/get_history_record</span>
  113. </div>
  114. <div class="api-card-body">
  115. <div class="api-title">获取历史记录</div>
  116. <div class="api-desc">获取当前用户的AI对话历史记录列表</div>
  117. <div class="params-title">请求参数</div>
  118. <div class="param-item">无参数,从Token获取用户ID</div>
  119. </div>
  120. </div>
  121. <div class="api-card">
  122. <div class="api-card-header">
  123. <span class="method post">POST</span>
  124. <span class="api-path">/apiv1/delete_conversation</span>
  125. </div>
  126. <div class="api-card-body">
  127. <div class="api-title">删除对话</div>
  128. <div class="api-desc">删除指定的AI对话</div>
  129. <div class="params-title">请求参数 (Body JSON)</div>
  130. <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
  131. </div>
  132. </div>
  133. <div class="api-card">
  134. <div class="api-card-header">
  135. <span class="method post">POST</span>
  136. <span class="api-path">/apiv1/delete_history_record</span>
  137. </div>
  138. <div class="api-card-body">
  139. <div class="api-title">删除历史记录</div>
  140. <div class="api-desc">删除指定的历史记录</div>
  141. <div class="params-title">请求参数 (Body JSON)</div>
  142. <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint64</span> - 记录ID</div>
  143. </div>
  144. </div>
  145. <div class="api-card">
  146. <div class="api-card-header">
  147. <span class="method post">POST</span>
  148. <span class="api-path">/apiv1/intent_recognition</span>
  149. </div>
  150. <div class="api-card-body">
  151. <div class="api-title">意图识别</div>
  152. <div class="api-desc">识别用户输入的意图类型</div>
  153. <div class="params-title">请求参数 (Body JSON)</div>
  154. <div class="param-item"><span class="param-name">message</span> <span class="param-type">string</span> - 用户消息</div>
  155. </div>
  156. </div>
  157. <div class="api-card">
  158. <div class="api-card-header">
  159. <span class="method get">GET</span>
  160. <span class="api-path">/apiv1/get_chromadb_document</span>
  161. </div>
  162. <div class="api-card-body">
  163. <div class="api-title">获取ChromaDB文档</div>
  164. <div class="api-desc">从向量数据库检索相关文档并生成回答</div>
  165. <div class="params-title">请求参数 (Query)</div>
  166. <div class="param-item"><span class="param-name">query</span> <span class="param-type">string</span> - 查询内容</div>
  167. </div>
  168. </div>
  169. <div class="api-card">
  170. <div class="api-card-header">
  171. <span class="method post">POST</span>
  172. <span class="api-path">/apiv1/guess_you_want</span>
  173. </div>
  174. <div class="api-card-body">
  175. <div class="api-title">猜你想问</div>
  176. <div class="api-desc">根据上下文推荐相关问题</div>
  177. <div class="params-title">请求参数 (Body JSON)</div>
  178. <div class="param-item"><span class="param-name">context</span> <span class="param-type">string</span> - 上下文内容</div>
  179. </div>
  180. </div>
  181. <div class="api-card">
  182. <div class="api-card-header">
  183. <span class="method get">GET</span>
  184. <span class="api-path">/apiv1/get_user_recommend_question</span>
  185. </div>
  186. <div class="api-card-body">
  187. <div class="api-title">用户输入推荐问题</div>
  188. <div class="api-desc">用户输入时实时返回推荐问题</div>
  189. <div class="params-title">请求参数 (Query)</div>
  190. <div class="param-item"><span class="param-name">input</span> <span class="param-type">string</span> - 用户输入内容</div>
  191. </div>
  192. </div>
  193. <div class="api-card">
  194. <div class="api-card-header">
  195. <span class="method get">GET</span>
  196. <span class="api-path">/apiv1/online_search</span>
  197. </div>
  198. <div class="api-card-body">
  199. <div class="api-title">联网搜索</div>
  200. <div class="api-desc">执行联网搜索获取实时信息</div>
  201. <div class="params-title">请求参数 (Query)</div>
  202. <div class="param-item"><span class="param-name">query</span> <span class="param-type">string</span> - 搜索关键词</div>
  203. </div>
  204. </div>
  205. <div class="api-card">
  206. <div class="api-card-header">
  207. <span class="method post">POST</span>
  208. <span class="api-path">/apiv1/save_online_search_result</span>
  209. </div>
  210. <div class="api-card-body">
  211. <div class="api-title">保存联网搜索结果</div>
  212. <div class="api-desc">将联网搜索结果存入AIMessage表</div>
  213. <div class="params-title">请求参数 (Body JSON)</div>
  214. <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 搜索结果内容</div>
  215. <div class="param-item"><span class="param-name">ai_message_id</span> <span class="param-type">uint64</span> - 消息ID</div>
  216. </div>
  217. </div>
  218. </div>
  219. <!-- 考试相关接口 -->
  220. <h2 class="section-title">📝 考试相关接口</h2>
  221. <div class="api-grid">
  222. <div class="api-card">
  223. <div class="api-card-header">
  224. <span class="method post">POST</span>
  225. <span class="api-path">/apiv1/exam/build_prompt</span>
  226. </div>
  227. <div class="api-card-body">
  228. <div class="api-title">生成考试提示词</div>
  229. <div class="api-desc">根据考试配置生成AI提示词</div>
  230. <div class="params-title">请求参数 (Body JSON)</div>
  231. <div class="param-item"><span class="param-name">exam_config</span> <span class="param-type">object</span> - 考试配置对象</div>
  232. </div>
  233. </div>
  234. <div class="api-card">
  235. <div class="api-card-header">
  236. <span class="method post">POST</span>
  237. <span class="api-path">/apiv1/exam/build_single_prompt</span>
  238. </div>
  239. <div class="api-card-body">
  240. <div class="api-title">单题生成提示词</div>
  241. <div class="api-desc">为单个题目重新生成提示词</div>
  242. <div class="params-title">请求参数 (Body JSON)</div>
  243. <div class="param-item"><span class="param-name">question_type</span> <span class="param-type">string</span> - 题目类型</div>
  244. <div class="param-item"><span class="param-name">context</span> <span class="param-type">string</span> - 上下文</div>
  245. </div>
  246. </div>
  247. <div class="api-card">
  248. <div class="api-card-header">
  249. <span class="method post">POST</span>
  250. <span class="api-path">/apiv1/re_modify_question</span>
  251. </div>
  252. <div class="api-card-body">
  253. <div class="api-title">修改考试题目</div>
  254. <div class="api-desc">修改已生成的考试题目内容</div>
  255. <div class="params-title">请求参数 (Body JSON)</div>
  256. <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
  257. <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 新内容</div>
  258. </div>
  259. </div>
  260. <div class="api-card">
  261. <div class="api-card-header">
  262. <span class="method post">POST</span>
  263. <span class="api-path">/apiv1/re_produce_single_question</span>
  264. </div>
  265. <div class="api-card-body">
  266. <div class="api-title">重新生成单题</div>
  267. <div class="api-desc">重新生成指定的单个考试题目</div>
  268. <div class="params-title">请求参数 (Body JSON)</div>
  269. <div class="param-item"><span class="param-name">question_id</span> <span class="param-type">uint64</span> - 题目ID</div>
  270. </div>
  271. </div>
  272. </div>
  273. <!-- 隐患识别接口 -->
  274. <h2 class="section-title">🔍 隐患识别接口</h2>
  275. <div class="api-grid">
  276. <div class="api-card">
  277. <div class="api-card-header">
  278. <span class="method post">POST</span>
  279. <span class="api-path">/apiv1/hazard</span>
  280. </div>
  281. <div class="api-card-body">
  282. <div class="api-title">隐患识别</div>
  283. <div class="api-desc">使用YOLO模型识别图片中的安全隐患,返回标注后的图片</div>
  284. <div class="params-title">请求参数 (Body JSON)</div>
  285. <div class="param-item"><span class="param-name">scene_name</span> <span class="param-type">string</span> - 场景名称(模型类型)</div>
  286. <div class="param-item"><span class="param-name">image</span> <span class="param-type">string</span> - 图片OSS链接</div>
  287. <div class="param-item"><span class="param-name">date</span> <span class="param-type">string</span> - 日期</div>
  288. </div>
  289. </div>
  290. <div class="api-card">
  291. <div class="api-card-header">
  292. <span class="method post">POST</span>
  293. <span class="api-path">/apiv1/save_step</span>
  294. </div>
  295. <div class="api-card-body">
  296. <div class="api-title">保存步骤</div>
  297. <div class="api-desc">保存PPT生成步骤、JSON文件和封面图</div>
  298. <div class="params-title">请求参数 (Body JSON)</div>
  299. <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
  300. <div class="param-item"><span class="param-name">step</span> <span class="param-type">int</span> - 步骤编号</div>
  301. <div class="param-item"><span class="param-name">ppt_json_url</span> <span class="param-type">string</span> - PPT JSON URL</div>
  302. <div class="param-item"><span class="param-name">cover_image</span> <span class="param-type">string</span> - 封面图URL</div>
  303. </div>
  304. </div>
  305. <div class="api-card">
  306. <div class="api-card-header">
  307. <span class="method get">GET</span>
  308. <span class="api-path">/apiv1/get_history_recognition_record</span>
  309. </div>
  310. <div class="api-card-body">
  311. <div class="api-title">获取识别历史记录</div>
  312. <div class="api-desc">获取当前用户的隐患识别历史记录</div>
  313. <div class="params-title">请求参数</div>
  314. <div class="param-item">无参数,从Token获取用户ID</div>
  315. </div>
  316. </div>
  317. <div class="api-card">
  318. <div class="api-card-header">
  319. <span class="method get">GET</span>
  320. <span class="api-path">/apiv1/get_recognition_record_detail</span>
  321. </div>
  322. <div class="api-card-body">
  323. <div class="api-title">获取识别记录详情</div>
  324. <div class="api-desc">获取指定识别记录的详细信息</div>
  325. <div class="params-title">请求参数 (Query)</div>
  326. <div class="param-item"><span class="param-name">recognition_record_id</span> <span class="param-type">int64</span> - 记录ID</div>
  327. </div>
  328. </div>
  329. <div class="api-card">
  330. <div class="api-card-header">
  331. <span class="method post">POST</span>
  332. <span class="api-path">/apiv1/delete_recognition_record</span>
  333. </div>
  334. <div class="api-card-body">
  335. <div class="api-title">删除识别记录</div>
  336. <div class="api-desc">删除指定的隐患识别历史记录</div>
  337. <div class="params-title">请求参数 (Body JSON)</div>
  338. <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint64</span> - 记录ID</div>
  339. </div>
  340. </div>
  341. <div class="api-card">
  342. <div class="api-card-header">
  343. <span class="method post">POST</span>
  344. <span class="api-path">/apiv1/submit_evaluation</span>
  345. </div>
  346. <div class="api-card-body">
  347. <div class="api-title">提交点评</div>
  348. <div class="api-desc">用户对识别结果提交点评反馈</div>
  349. <div class="params-title">请求参数 (Body JSON)</div>
  350. <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint</span> - 记录ID</div>
  351. <div class="param-item"><span class="param-name">scene_match</span> <span class="param-type">int</span> - 场景匹配度</div>
  352. <div class="param-item"><span class="param-name">tip_accuracy</span> <span class="param-type">int</span> - 提示准确度</div>
  353. <div class="param-item"><span class="param-name">effect_evaluation</span> <span class="param-type">int</span> - 效果评价</div>
  354. <div class="param-item"><span class="param-name">user_remark</span> <span class="param-type">string</span> - 用户备注</div>
  355. </div>
  356. </div>
  357. <div class="api-card">
  358. <div class="api-card-header">
  359. <span class="method get">GET</span>
  360. <span class="api-path">/apiv1/get_latest_recognition_record</span>
  361. </div>
  362. <div class="api-card-body">
  363. <div class="api-title">获取最新识别记录</div>
  364. <div class="api-desc">查询用户最新的一条识别记录是否已点评</div>
  365. <div class="params-title">请求参数</div>
  366. <div class="param-item">无参数,从Token获取用户ID</div>
  367. </div>
  368. </div>
  369. <div class="api-card">
  370. <div class="api-card-header">
  371. <span class="method get">GET</span>
  372. <span class="api-path">/apiv1/get_third_scene_example_image</span>
  373. </div>
  374. <div class="api-card-body">
  375. <div class="api-title">获取三级场景示例图</div>
  376. <div class="api-desc">获取隐患识别三级场景的正确和错误示例图</div>
  377. <div class="params-title">请求参数 (Query)</div>
  378. <div class="param-item"><span class="param-name">third_scene_name</span> <span class="param-type">string</span> - 三级场景名称</div>
  379. </div>
  380. </div>
  381. </div>
  382. <!-- OSS文件上传接口 -->
  383. <h2 class="section-title">📁 OSS文件上传接口</h2>
  384. <div class="api-grid">
  385. <div class="api-card">
  386. <div class="api-card-header">
  387. <span class="method post">POST</span>
  388. <span class="api-path">/apiv1/oss/upload</span>
  389. </div>
  390. <div class="api-card-body">
  391. <div class="api-title">获取上传凭证</div>
  392. <div class="api-desc">生成S3预签名上传凭证,用于前端直传OSS</div>
  393. <div class="params-title">响应</div>
  394. <div class="param-item"><span class="param-name">url</span> - 上传地址</div>
  395. <div class="param-item"><span class="param-name">fields</span> - 签名字段</div>
  396. <div class="param-item"><span class="param-name">expire</span> - 过期时间</div>
  397. </div>
  398. </div>
  399. <div class="api-card">
  400. <div class="api-card-header">
  401. <span class="method post">POST</span>
  402. <span class="api-path">/apiv1/oss/shudao/upload_image</span>
  403. </div>
  404. <div class="api-card-body">
  405. <div class="api-title">上传图片</div>
  406. <div class="api-desc">上传图片到OSS,自动压缩到200KB以下</div>
  407. <div class="params-title">请求参数 (FormData)</div>
  408. <div class="param-item"><span class="param-name">image</span> <span class="param-type">file</span> - 图片文件(≤10MB)</div>
  409. <div class="params-title" style="margin-top:8px">响应</div>
  410. <div class="param-item"><span class="param-name">fileUrl</span> - 代理访问URL</div>
  411. <div class="param-item"><span class="param-name">fileName</span> - 文件名</div>
  412. <div class="param-item"><span class="param-name">fileSize</span> - 文件大小</div>
  413. </div>
  414. </div>
  415. <div class="api-card">
  416. <div class="api-card-header">
  417. <span class="method post">POST</span>
  418. <span class="api-path">/apiv1/oss/shudao/upload_json</span>
  419. </div>
  420. <div class="api-card-body">
  421. <div class="api-title">上传PPT JSON文件</div>
  422. <div class="api-desc">上传PPT配置JSON文件到OSS</div>
  423. <div class="params-title">请求参数 (FormData)</div>
  424. <div class="param-item"><span class="param-name">json</span> <span class="param-type">file</span> - JSON文件(≤50MB)</div>
  425. <div class="params-title" style="margin-top:8px">响应</div>
  426. <div class="param-item"><span class="param-name">fileUrl</span> - 代理访问URL</div>
  427. </div>
  428. </div>
  429. <div class="api-card">
  430. <div class="api-card-header">
  431. <span class="method get">GET</span>
  432. <span class="api-path">/apiv1/oss/parse</span>
  433. </div>
  434. <div class="api-card-body">
  435. <div class="api-title">OSS代理解析</div>
  436. <div class="api-desc">代理转发OSS URL请求,解密并获取文件内容</div>
  437. <div class="params-title">请求参数 (Query)</div>
  438. <div class="param-item"><span class="param-name">url</span> <span class="param-type">string</span> - 加密的OSS URL</div>
  439. </div>
  440. </div>
  441. </div>
  442. <!-- 通用功能接口 -->
  443. <h2 class="section-title">🔧 通用功能接口</h2>
  444. <div class="api-grid">
  445. <div class="api-card">
  446. <div class="api-card-header">
  447. <span class="method get">GET</span>
  448. <span class="api-path">/apiv1/recommend_question</span>
  449. </div>
  450. <div class="api-card-body">
  451. <div class="api-title">获取推荐问题</div>
  452. <div class="api-desc">随机返回推荐问题列表</div>
  453. <div class="params-title">请求参数 (Query)</div>
  454. <div class="param-item"><span class="param-name">limit</span> <span class="param-type">int</span> - 数量(默认5)</div>
  455. </div>
  456. </div>
  457. <div class="api-card">
  458. <div class="api-card-header">
  459. <span class="method get">GET</span>
  460. <span class="api-path">/apiv1/get_function_card</span>
  461. </div>
  462. <div class="api-card-body">
  463. <div class="api-title">获取功能卡片</div>
  464. <div class="api-desc">随机返回4条功能卡片</div>
  465. <div class="params-title">请求参数 (Query)</div>
  466. <div class="param-item"><span class="param-name">function_type</span> <span class="param-type">int</span> - 类型(0:AI问答,1:安全培训)</div>
  467. </div>
  468. </div>
  469. <div class="api-card">
  470. <div class="api-card-header">
  471. <span class="method get">GET</span>
  472. <span class="api-path">/apiv1/get_hot_question</span>
  473. </div>
  474. <div class="api-card-body">
  475. <div class="api-title">获取热点问题</div>
  476. <div class="api-desc">随机返回4条热点问题</div>
  477. <div class="params-title">请求参数 (Query)</div>
  478. <div class="param-item"><span class="param-name">question_type</span> <span class="param-type">int</span> - 类型(0:AI问答,1:安全培训)</div>
  479. </div>
  480. </div>
  481. <div class="api-card">
  482. <div class="api-card-header">
  483. <span class="method post">POST</span>
  484. <span class="api-path">/apiv1/submit_feedback</span>
  485. </div>
  486. <div class="api-card-body">
  487. <div class="api-title">提交意见反馈</div>
  488. <div class="api-desc">用户提交意见反馈信息</div>
  489. <div class="params-title">请求参数 (Body JSON)</div>
  490. <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 反馈内容</div>
  491. <div class="param-item"><span class="param-name">contact</span> <span class="param-type">string</span> - 联系方式</div>
  492. </div>
  493. </div>
  494. <div class="api-card">
  495. <div class="api-card-header">
  496. <span class="method post">POST</span>
  497. <span class="api-path">/apiv1/like_and_dislike</span>
  498. </div>
  499. <div class="api-card-body">
  500. <div class="api-title">点赞/踩</div>
  501. <div class="api-desc">对AI回复进行点赞或踩的反馈</div>
  502. <div class="params-title">请求参数 (Body JSON)</div>
  503. <div class="param-item"><span class="param-name">id</span> <span class="param-type">uint</span> - 消息ID</div>
  504. <div class="param-item"><span class="param-name">user_feedback</span> <span class="param-type">int</span> - 反馈(1:赞,-1:踩)</div>
  505. </div>
  506. </div>
  507. <div class="api-card">
  508. <div class="api-card-header">
  509. <span class="method get">GET</span>
  510. <span class="api-path">/apiv1/get_user_data_id</span>
  511. </div>
  512. <div class="api-card-body">
  513. <div class="api-title">获取用户数据ID</div>
  514. <div class="api-desc">根据account_id获取用户数据主键ID</div>
  515. <div class="params-title">请求参数</div>
  516. <div class="param-item">无参数,从Token获取account_id</div>
  517. </div>
  518. </div>
  519. </div>
  520. <!-- 政策文件接口 -->
  521. <h2 class="section-title">📄 政策文件接口</h2>
  522. <div class="api-grid">
  523. <div class="api-card">
  524. <div class="api-card-header">
  525. <span class="method get">GET</span>
  526. <span class="api-path">/apiv1/get_policy_file</span>
  527. </div>
  528. <div class="api-card-body">
  529. <div class="api-title">获取政策文件列表</div>
  530. <div class="api-desc">分页获取政策文件列表,支持类型筛选和搜索</div>
  531. <div class="params-title">请求参数 (Query)</div>
  532. <div class="param-item"><span class="param-name">policy_type</span> <span class="param-type">int</span> - 政策类型(0:全部)</div>
  533. <div class="param-item"><span class="param-name">search</span> <span class="param-type">string</span> - 搜索关键词</div>
  534. <div class="param-item"><span class="param-name">page</span> <span class="param-type">int</span> - 页码</div>
  535. <div class="param-item"><span class="param-name">pageSize</span> <span class="param-type">int</span> - 每页数量</div>
  536. </div>
  537. </div>
  538. <div class="api-card">
  539. <div class="api-card-header">
  540. <span class="method get">GET</span>
  541. <span class="api-path">/apiv1/download_file</span>
  542. </div>
  543. <div class="api-card-body">
  544. <div class="api-title">下载文件</div>
  545. <div class="api-desc">从OSS链接下载文件并返回给前端</div>
  546. <div class="params-title">请求参数 (Query)</div>
  547. <div class="param-item"><span class="param-name">pdf_oss_download_link</span> <span class="param-type">string</span> - OSS下载链接</div>
  548. <div class="param-item"><span class="param-name">file_name</span> <span class="param-type">string</span> - 自定义文件名(可选)</div>
  549. </div>
  550. </div>
  551. <div class="api-card">
  552. <div class="api-card-header">
  553. <span class="method post">POST</span>
  554. <span class="api-path">/apiv1/policy_file_count</span>
  555. </div>
  556. <div class="api-card-body">
  557. <div class="api-title">政策文件统计</div>
  558. <div class="api-desc">政策文件查看和下载次数+1</div>
  559. <div class="params-title">请求参数 (Body JSON)</div>
  560. <div class="param-item"><span class="param-name">policy_file_id</span> <span class="param-type">int</span> - 政策文件ID</div>
  561. <div class="param-item"><span class="param-name">action_type</span> <span class="param-type">int</span> - 操作类型(1:查看,2:下载)</div>
  562. </div>
  563. </div>
  564. <div class="api-card">
  565. <div class="api-card-header">
  566. <span class="method get">GET</span>
  567. <span class="api-path">/apiv1/get_file_link</span>
  568. </div>
  569. <div class="api-card-body">
  570. <div class="api-title">获取文件链接</div>
  571. <div class="api-desc">根据文件名从数据库查找对应的OSS链接</div>
  572. <div class="params-title">请求参数 (Query)</div>
  573. <div class="param-item"><span class="param-name">file_name</span> <span class="param-type">string</span> - 文件名</div>
  574. </div>
  575. </div>
  576. <div class="api-card">
  577. <div class="api-card-header">
  578. <span class="method get">GET</span>
  579. <span class="api-path">/apiv1/knowledge/files/advanced-search</span>
  580. </div>
  581. <div class="api-card-body">
  582. <div class="api-title">知识库高级搜索</div>
  583. <div class="api-desc">从ChromaDB向量数据库进行高级文件搜索</div>
  584. <div class="params-title">请求参数 (Query)</div>
  585. <div class="param-item"><span class="param-name">query_str</span> <span class="param-type">string</span> - 查询字符串</div>
  586. <div class="param-item"><span class="param-name">n_results</span> <span class="param-type">int</span> - 结果数量(默认50)</div>
  587. </div>
  588. </div>
  589. <div class="api-card">
  590. <div class="api-card-header">
  591. <span class="method post">POST</span>
  592. <span class="api-path">/apiv1/save_ppt_outline</span>
  593. </div>
  594. <div class="api-card-body">
  595. <div class="api-title">保存PPT大纲</div>
  596. <div class="api-desc">保存AI生成的PPT大纲内容</div>
  597. <div class="params-title">请求参数 (Body JSON)</div>
  598. <div class="param-item"><span class="param-name">ai_conversation_id</span> <span class="param-type">uint64</span> - 对话ID</div>
  599. <div class="param-item"><span class="param-name">outline</span> <span class="param-type">string</span> - 大纲内容</div>
  600. </div>
  601. </div>
  602. <div class="api-card">
  603. <div class="api-card-header">
  604. <span class="method post">POST</span>
  605. <span class="api-path">/apiv1/save_edit_document</span>
  606. </div>
  607. <div class="api-card-body">
  608. <div class="api-title">保存编辑文档</div>
  609. <div class="api-desc">AI写作保存编辑后的文档内容</div>
  610. <div class="params-title">请求参数 (Body JSON)</div>
  611. <div class="param-item"><span class="param-name">ai_message_id</span> <span class="param-type">uint64</span> - 消息ID</div>
  612. <div class="param-item"><span class="param-name">content</span> <span class="param-type">string</span> - 文档内容</div>
  613. </div>
  614. </div>
  615. </div>
  616. <!-- 积分系统接口 -->
  617. <h2 class="section-title">💰 积分系统接口</h2>
  618. <div class="api-grid">
  619. <div class="api-card">
  620. <div class="api-card-header">
  621. <span class="method get">GET</span>
  622. <span class="api-path">/apiv1/points/balance</span>
  623. </div>
  624. <div class="api-card-body">
  625. <div class="api-title">获取积分余额</div>
  626. <div class="api-desc">获取当前用户的积分余额</div>
  627. <div class="params-title">请求参数</div>
  628. <div class="param-item">无参数,从Token获取用户ID</div>
  629. <div class="params-title" style="margin-top:8px">响应</div>
  630. <div class="param-item"><span class="param-name">points</span> - 积分余额</div>
  631. </div>
  632. </div>
  633. <div class="api-card">
  634. <div class="api-card-header">
  635. <span class="method post">POST</span>
  636. <span class="api-path">/apiv1/points/consume</span>
  637. </div>
  638. <div class="api-card-body">
  639. <div class="api-title">消费积分</div>
  640. <div class="api-desc">消费积分下载文件(每次10积分)</div>
  641. <div class="params-title">请求参数 (Body JSON)</div>
  642. <div class="param-item"><span class="param-name">file_name</span> <span class="param-type">string</span> - 文件名</div>
  643. <div class="param-item"><span class="param-name">file_url</span> <span class="param-type">string</span> - 文件URL</div>
  644. <div class="params-title" style="margin-top:8px">响应</div>
  645. <div class="param-item"><span class="param-name">new_balance</span> - 新余额</div>
  646. <div class="param-item"><span class="param-name">points_consumed</span> - 消费积分</div>
  647. </div>
  648. </div>
  649. <div class="api-card">
  650. <div class="api-card-header">
  651. <span class="method get">GET</span>
  652. <span class="api-path">/apiv1/points/history</span>
  653. </div>
  654. <div class="api-card-body">
  655. <div class="api-title">获取消费记录</div>
  656. <div class="api-desc">分页获取用户的积分消费历史记录</div>
  657. <div class="params-title">请求参数 (Query)</div>
  658. <div class="param-item"><span class="param-name">page</span> <span class="param-type">int</span> - 页码(默认1)</div>
  659. <div class="param-item"><span class="param-name">pageSize</span> <span class="param-type">int</span> - 每页数量(默认10)</div>
  660. </div>
  661. </div>
  662. </div>
  663. <!-- 埋点记录接口 -->
  664. <h2 class="section-title">📊 埋点记录接口</h2>
  665. <div class="api-grid">
  666. <div class="api-card">
  667. <div class="api-card-header">
  668. <span class="method post">POST</span>
  669. <span class="api-path">/apiv1/tracking/record</span>
  670. </div>
  671. <div class="api-card-body">
  672. <div class="api-title">记录埋点数据</div>
  673. <div class="api-desc">记录用户行为埋点数据</div>
  674. <div class="params-title">请求参数 (Body JSON)</div>
  675. <div class="param-item"><span class="param-name">api_path</span> <span class="param-type">string</span> - 接口路径</div>
  676. <div class="param-item"><span class="param-name">method</span> <span class="param-type">string</span> - 请求方法</div>
  677. <div class="param-item"><span class="param-name">extra_data</span> <span class="param-type">string</span> - 额外数据(可选)</div>
  678. </div>
  679. </div>
  680. <div class="api-card">
  681. <div class="api-card-header">
  682. <span class="method get">GET</span>
  683. <span class="api-path">/apiv1/tracking/records</span>
  684. </div>
  685. <div class="api-card-body">
  686. <div class="api-title">获取埋点记录</div>
  687. <div class="api-desc">分页获取埋点记录列表</div>
  688. <div class="params-title">请求参数 (Query)</div>
  689. <div class="param-item"><span class="param-name">user_id</span> <span class="param-type">int</span> - 用户ID(可选)</div>
  690. <div class="param-item"><span class="param-name">api_path</span> <span class="param-type">string</span> - 接口路径(可选)</div>
  691. <div class="param-item"><span class="param-name">page</span> <span class="param-type">int</span> - 页码(默认1)</div>
  692. <div class="param-item"><span class="param-name">page_size</span> <span class="param-type">int</span> - 每页数量(默认20)</div>
  693. </div>
  694. </div>
  695. <div class="api-card">
  696. <div class="api-card-header">
  697. <span class="method post">POST</span>
  698. <span class="api-path">/apiv1/tracking/api_mapping</span>
  699. </div>
  700. <div class="api-card-body">
  701. <div class="api-title">添加接口映射</div>
  702. <div class="api-desc">添加接口路径到名称的映射关系</div>
  703. <div class="params-title">请求参数 (Body JSON)</div>
  704. <div class="param-item"><span class="param-name">api_path</span> <span class="param-type">string</span> - 接口路径</div>
  705. <div class="param-item"><span class="param-name">api_name</span> <span class="param-type">string</span> - 接口名称</div>
  706. <div class="param-item"><span class="param-name">api_desc</span> <span class="param-type">string</span> - 接口描述(可选)</div>
  707. </div>
  708. </div>
  709. <div class="api-card">
  710. <div class="api-card-header">
  711. <span class="method get">GET</span>
  712. <span class="api-path">/apiv1/tracking/api_mappings</span>
  713. </div>
  714. <div class="api-card-body">
  715. <div class="api-title">获取接口映射列表</div>
  716. <div class="api-desc">获取所有接口路径映射关系</div>
  717. <div class="params-title">请求参数</div>
  718. <div class="param-item">无参数</div>
  719. </div>
  720. </div>
  721. </div>
  722. <div style="text-align:center; padding:30px; color:#9ca3af; font-size:12px;">
  723. <p>蜀道安全AI系统 API文档 v1.0 | 共 <strong>45</strong> 个接口</p>
  724. <p>基础路径: <code>/apiv1</code> | 认证方式: JWT Token (Header: Authorization)</p>
  725. <p>生成时间: 2024年12月</p>
  726. </div>
  727. </div>
  728. </body>
  729. </html>