prompt_api.py 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. """
  2. 提示词管理 API 端点
  3. 提供提示词的查询、版本管理、对比、激活和回滚功能。
  4. 基于 core/debug/prompt_manager.py 的 PromptManager 实现。
  5. """
  6. import logging
  7. from fastapi import APIRouter, Query, HTTPException
  8. from pydantic import ValidationError
  9. from core.debug.prompt_manager import PromptManager, CHAINS, PROMPT_FILE_MAP, PROMPT_CHAIN_MAP
  10. logger = logging.getLogger(__name__)
  11. # 全局 PromptManager 实例
  12. _prompt_manager = None
  13. def _get_manager() -> PromptManager:
  14. """获取或创建 PromptManager 单例"""
  15. global _prompt_manager
  16. if _prompt_manager is None:
  17. _prompt_manager = PromptManager()
  18. return _prompt_manager
  19. def register_routes(router: APIRouter):
  20. """在指定 router 上注册提示词管理路由"""
  21. @router.get(
  22. '/api/prompts',
  23. summary='获取提示词列表',
  24. description='获取所有提示词及其版本信息,支持链路筛选和名称搜索。',
  25. )
  26. async def list_prompts(
  27. chain: str = Query(default=None, description='链路筛选'),
  28. search: str = Query(default=None, description='名称搜索'),
  29. page: int = Query(default=1, ge=1, description='页码'),
  30. page_size: int = Query(default=50, ge=1, le=200, description='每页条数'),
  31. ):
  32. """
  33. 获取所有提示词及其版本信息。
  34. """
  35. try:
  36. manager = _get_manager()
  37. items = manager.get_all_prompts(chain_filter=chain, search=search)
  38. # 分页
  39. total = len(items)
  40. start = (page - 1) * page_size
  41. paged_items = items[start:start + page_size]
  42. return {
  43. 'status': 'ok',
  44. 'total': total,
  45. 'page': page,
  46. 'page_size': page_size,
  47. 'items': paged_items,
  48. 'chains': CHAINS,
  49. }
  50. except Exception as e:
  51. logger.error('获取提示词列表失败: %s', e)
  52. raise HTTPException(status_code=500, detail=str(e))
  53. @router.get(
  54. '/api/prompts/{name}',
  55. summary='获取提示词详情',
  56. description='获取指定提示词指定版本的完整详情,包括 system_prompt 和 user_prompt。',
  57. )
  58. async def get_prompt_detail(
  59. name: str,
  60. version: str = Query(default=None, description='版本号,不指定则返回当前激活版本'),
  61. ):
  62. """
  63. 获取指定提示词的完整详情,包括系统提示词和用户提示词模板。
  64. """
  65. try:
  66. manager = _get_manager()
  67. detail = manager.get_prompt_detail(name, version=version)
  68. if detail is None:
  69. raise HTTPException(
  70. status_code=404,
  71. detail=f'提示词不存在: {name}',
  72. )
  73. return {
  74. 'status': 'ok',
  75. **detail,
  76. }
  77. except HTTPException:
  78. raise
  79. except Exception as e:
  80. logger.error('获取提示词详情失败: %s', e)
  81. raise HTTPException(status_code=500, detail=str(e))
  82. @router.get(
  83. '/api/prompts/{name}/versions',
  84. summary='获取版本列表',
  85. description='获取指定提示词的所有历史版本。',
  86. )
  87. async def list_prompt_versions(name: str):
  88. """
  89. 获取指定提示词的所有历史版本。
  90. """
  91. try:
  92. manager = _get_manager()
  93. # 先检查提示词是否存在
  94. if name not in PROMPT_FILE_MAP:
  95. detail = manager.get_prompt_detail(name)
  96. if detail is None:
  97. raise HTTPException(
  98. status_code=404,
  99. detail=f'提示词不存在: {name}',
  100. )
  101. # 获取当前激活版本
  102. current_info = manager.get_prompt_detail(name)
  103. current_version = current_info.get('version', '') if current_info else ''
  104. versions = manager.get_versions(name)
  105. chain = PROMPT_CHAIN_MAP.get(name, '')
  106. return {
  107. 'status': 'ok',
  108. 'name': name,
  109. 'chain': chain,
  110. 'current_version': current_version,
  111. 'versions': versions,
  112. }
  113. except HTTPException:
  114. raise
  115. except Exception as e:
  116. logger.error('获取版本列表失败: %s', e)
  117. raise HTTPException(status_code=500, detail=str(e))
  118. @router.post(
  119. '/api/prompts/save',
  120. summary='保存新版本',
  121. description='保存提示词的新版本。将当前编辑内容保存为新版本,并可选设为当前激活版本。',
  122. )
  123. async def save_prompt_version(body: dict):
  124. """
  125. 保存提示词的新版本。
  126. """
  127. try:
  128. name = body.get('name', '')
  129. system_prompt = body.get('system_prompt', '')
  130. user_prompt = body.get('user_prompt', '')
  131. note = body.get('note', '')
  132. set_current = body.get('set_current', True)
  133. # 参数验证
  134. if not name:
  135. raise HTTPException(status_code=422, detail='name 不能为空')
  136. if not system_prompt:
  137. raise HTTPException(status_code=422, detail='system_prompt 不能为空')
  138. if not user_prompt:
  139. raise HTTPException(status_code=422, detail='user_prompt 不能为空')
  140. manager = _get_manager()
  141. result = manager.save_new_version(
  142. name=name,
  143. system_prompt=system_prompt,
  144. user_prompt=user_prompt,
  145. note=note,
  146. set_current=set_current,
  147. )
  148. return {
  149. 'success': True,
  150. 'name': result['name'],
  151. 'version': result['version'],
  152. 'time': result['time'],
  153. 'message': f'已保存新版本 {result["version"]}',
  154. }
  155. except HTTPException:
  156. raise
  157. except ValueError as e:
  158. raise HTTPException(status_code=404, detail=str(e))
  159. except Exception as e:
  160. logger.error('保存新版本失败: %s', e)
  161. raise HTTPException(status_code=500, detail=str(e))
  162. @router.post(
  163. '/api/prompts/compare',
  164. summary='版本对比',
  165. description='对比两个版本的差异(行级 Diff)。',
  166. )
  167. async def compare_prompt_versions(body: dict):
  168. """
  169. 对比两个版本的差异。
  170. """
  171. try:
  172. name = body.get('name', '')
  173. base_version = body.get('base_version', '')
  174. target_version = body.get('target_version', '')
  175. if not name or not base_version or not target_version:
  176. raise HTTPException(
  177. status_code=422,
  178. detail='name, base_version, target_version 不能为空',
  179. )
  180. manager = _get_manager()
  181. result = manager.compare_versions(name, base_version, target_version)
  182. return {
  183. 'status': 'ok',
  184. **result,
  185. }
  186. except HTTPException:
  187. raise
  188. except FileNotFoundError as e:
  189. raise HTTPException(status_code=404, detail=str(e))
  190. except Exception as e:
  191. logger.error('版本对比失败: %s', e)
  192. raise HTTPException(status_code=500, detail=str(e))
  193. @router.post(
  194. '/api/prompts/activate',
  195. summary='激活版本',
  196. description='将指定版本设为当前激活版本(覆盖写入主 YAML 文件)。',
  197. )
  198. async def activate_prompt_version(body: dict):
  199. """
  200. 将指定版本设为当前激活版本。
  201. """
  202. try:
  203. name = body.get('name', '')
  204. version = body.get('version', '')
  205. if not name or not version:
  206. raise HTTPException(
  207. status_code=422,
  208. detail='name, version 不能为空',
  209. )
  210. manager = _get_manager()
  211. result = manager.activate_version(name, version)
  212. return {
  213. 'success': result['success'],
  214. 'name': result['name'],
  215. 'version': result['version'],
  216. 'message': f'已激活版本 {result["version"]}',
  217. }
  218. except HTTPException:
  219. raise
  220. except (ValueError, FileNotFoundError) as e:
  221. raise HTTPException(status_code=404, detail=str(e))
  222. except Exception as e:
  223. logger.error('激活版本失败: %s', e)
  224. raise HTTPException(status_code=500, detail=str(e))
  225. @router.post(
  226. '/api/prompts/rollback',
  227. summary='回滚版本',
  228. description='回滚到指定历史版本(等同于将该版本内容设为当前激活版本)。',
  229. )
  230. async def rollback_prompt_version(body: dict):
  231. """
  232. 回滚到指定历史版本。
  233. """
  234. try:
  235. name = body.get('name', '')
  236. version = body.get('version', '')
  237. if not name or not version:
  238. raise HTTPException(
  239. status_code=422,
  240. detail='name, version 不能为空',
  241. )
  242. manager = _get_manager()
  243. result = manager.rollback_version(name, version)
  244. return {
  245. 'success': result['success'],
  246. 'name': result['name'],
  247. 'version': result['version'],
  248. 'message': f'已回滚到版本 {result["version"]}',
  249. }
  250. except HTTPException:
  251. raise
  252. except (ValueError, FileNotFoundError) as e:
  253. raise HTTPException(status_code=404, detail=str(e))
  254. except Exception as e:
  255. logger.error('回滚版本失败: %s', e)
  256. raise HTTPException(status_code=500, detail=str(e))