api-docs.html 48 KB

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