knowledge_workflow.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422
  1. # coding=utf-8
  2. from django.utils.translation import gettext_lazy as _
  3. from drf_spectacular.utils import extend_schema
  4. from rest_framework.request import Request
  5. from rest_framework.views import APIView
  6. from application.api.application_api import SpeechToTextAPI
  7. from common.auth import TokenAuth
  8. from common.auth.authentication import has_permissions, get_is_permissions
  9. from common.constants.permission_constants import PermissionConstants, RoleConstants, ViewPermission, CompareConstants
  10. from common.log.log import log
  11. from common.result import result, DefaultResultSerializer
  12. from knowledge.api.knowledge_workflow import KnowledgeWorkflowApi, KnowledgeWorkflowActionApi, \
  13. KnowledgeWorkflowActionPageApi, KnowledgeWorkflowExportApi, KnowledgeWorkflowImportApi
  14. from knowledge.serializers.common import get_knowledge_operation_object
  15. from knowledge.serializers.knowledge_workflow import KnowledgeWorkflowSerializer, KnowledgeWorkflowActionSerializer, \
  16. KnowledgeWorkflowMcpSerializer
  17. class KnowledgeDatasourceFormListView(APIView):
  18. authentication_classes = [TokenAuth]
  19. @has_permissions(
  20. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_knowledge_permission(),
  21. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_permission_workspace_manage_role(),
  22. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  23. ViewPermission(
  24. [RoleConstants.USER.get_workspace_role()],
  25. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  26. CompareConstants.AND
  27. ),
  28. )
  29. def post(self, request: Request, workspace_id: str, knowledge_id: str, type: str, id: str):
  30. r = KnowledgeWorkflowSerializer.Datasource(
  31. data={'type': type, 'id': id, 'params': request.data, 'function_name': 'get_form_list'}
  32. ).action()
  33. return result.success(r)
  34. class KnowledgeDatasourceView(APIView):
  35. authentication_classes = [TokenAuth]
  36. @has_permissions(
  37. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_knowledge_permission(),
  38. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_permission_workspace_manage_role(),
  39. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  40. ViewPermission(
  41. [RoleConstants.USER.get_workspace_role()],
  42. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  43. CompareConstants.AND
  44. ),
  45. )
  46. def post(self, request: Request, workspace_id: str, knowledge_id: str, type: str, id: str, function_name: str):
  47. return result.success(KnowledgeWorkflowSerializer.Datasource(
  48. data={'type': type, 'id': id, 'params': request.data, 'function_name': function_name}).action())
  49. class KnowledgeWorkflowUploadDocumentView(APIView):
  50. authentication_classes = [TokenAuth]
  51. @extend_schema(
  52. methods=['GET'],
  53. description=_('Knowledge workflow upload document'),
  54. summary=_('Knowledge workflow upload document'),
  55. operation_id=_('Knowledge workflow upload document'), # type: ignore
  56. parameters=KnowledgeWorkflowActionApi.get_parameters(),
  57. request=KnowledgeWorkflowActionApi.get_request(),
  58. responses=KnowledgeWorkflowActionApi.get_response(),
  59. tags=[_('Knowledge Base')] # type: ignore
  60. )
  61. @has_permissions(
  62. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_knowledge_permission(),
  63. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_permission_workspace_manage_role(),
  64. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  65. ViewPermission(
  66. [RoleConstants.USER.get_workspace_role()],
  67. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  68. CompareConstants.AND
  69. ),
  70. )
  71. def post(self, request: Request, workspace_id: str, knowledge_id: str):
  72. return result.success(KnowledgeWorkflowActionSerializer(
  73. data={'workspace_id': workspace_id, 'knowledge_id': knowledge_id}).upload_document(request.data,
  74. request.user, True))
  75. class KnowledgeWorkflowActionView(APIView):
  76. authentication_classes = [TokenAuth]
  77. @extend_schema(
  78. methods=['POST'],
  79. description=_('Knowledge workflow debug'),
  80. summary=_('Knowledge workflow debug'),
  81. operation_id=_('Knowledge workflow debug'), # type: ignore
  82. parameters=KnowledgeWorkflowActionApi.get_parameters(),
  83. request=KnowledgeWorkflowActionApi.get_request(),
  84. responses=KnowledgeWorkflowActionApi.get_response(),
  85. tags=[_('Knowledge Base')] # type: ignore
  86. )
  87. @has_permissions(
  88. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_knowledge_permission(),
  89. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_permission_workspace_manage_role(),
  90. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  91. ViewPermission(
  92. [RoleConstants.USER.get_workspace_role()],
  93. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  94. CompareConstants.AND
  95. ),
  96. )
  97. def post(self, request: Request, workspace_id: str, knowledge_id: str):
  98. return result.success(KnowledgeWorkflowActionSerializer(
  99. data={'workspace_id': workspace_id, 'knowledge_id': knowledge_id}).action(request.data, request.user, True))
  100. class Page(APIView):
  101. authentication_classes = [TokenAuth]
  102. @extend_schema(
  103. methods=['GET'],
  104. description=_('Page Knowledge workflow action'),
  105. summary=_('Page Knowledge workflow action'),
  106. operation_id=_('Page Knowledge workflow action'), # type: ignore
  107. parameters=KnowledgeWorkflowActionApi.get_parameters(),
  108. request=KnowledgeWorkflowActionPageApi.get_request(),
  109. responses=KnowledgeWorkflowActionApi.get_response(),
  110. tags=[_('Knowledge Base')] # type: ignore
  111. )
  112. @has_permissions(
  113. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_knowledge_permission(),
  114. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_permission_workspace_manage_role(),
  115. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  116. ViewPermission(
  117. [RoleConstants.USER.get_workspace_role()],
  118. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  119. CompareConstants.AND
  120. ),
  121. )
  122. def get(self, request: Request, workspace_id: str, knowledge_id: str, current_page: int, page_size: int):
  123. return result.success(
  124. KnowledgeWorkflowActionSerializer(data={'workspace_id': workspace_id, 'knowledge_id': knowledge_id})
  125. .page(current_page, page_size, request.query_params))
  126. class Operate(APIView):
  127. authentication_classes = [TokenAuth]
  128. @extend_schema(
  129. methods=['GET'],
  130. description=_('Get knowledge workflow action'),
  131. summary=_('Get knowledge workflow action'),
  132. operation_id=_('Get knowledge workflow action'), # type: ignore
  133. parameters=KnowledgeWorkflowActionApi.get_parameters(),
  134. responses=KnowledgeWorkflowActionApi.get_response(),
  135. tags=[_('Knowledge Base')] # type: ignore
  136. )
  137. @has_permissions(
  138. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_knowledge_permission(),
  139. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_permission_workspace_manage_role(),
  140. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  141. ViewPermission(
  142. [RoleConstants.USER.get_workspace_role()],
  143. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  144. CompareConstants.AND
  145. ),
  146. )
  147. def get(self, request, workspace_id: str, knowledge_id: str, knowledge_action_id: str):
  148. return result.success(KnowledgeWorkflowActionSerializer.Operate(
  149. data={'workspace_id': workspace_id, 'knowledge_id': knowledge_id, 'id': knowledge_action_id})
  150. .one())
  151. class Cancel(APIView):
  152. authentication_classes = [TokenAuth]
  153. @extend_schema(
  154. methods=['POST'],
  155. description=_('Cancel knowledge workflow action'),
  156. summary=_('Cancel knowledge workflow action'),
  157. operation_id=_('Cancel knowledge workflow action'), # type: ignore
  158. parameters=KnowledgeWorkflowActionApi.get_parameters(),
  159. responses=DefaultResultSerializer(),
  160. tags=[_('Knowledge Base')] # type: ignore
  161. )
  162. @has_permissions(
  163. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_knowledge_permission(),
  164. PermissionConstants.KNOWLEDGE_DOCUMENT_CREATE.get_workspace_permission_workspace_manage_role(),
  165. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  166. ViewPermission(
  167. [RoleConstants.USER.get_workspace_role()],
  168. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  169. CompareConstants.AND
  170. ),
  171. )
  172. def post(self, request, workspace_id: str, knowledge_id: str, knowledge_action_id: str):
  173. return result.success(KnowledgeWorkflowActionSerializer.Operate(
  174. data={'workspace_id': workspace_id, 'knowledge_id': knowledge_id, 'id': knowledge_action_id})
  175. .cancel())
  176. class KnowledgeWorkflowView(APIView):
  177. authentication_classes = [TokenAuth]
  178. @extend_schema(
  179. methods=['POST'],
  180. description=_('Create knowledge workflow'),
  181. summary=_('Create knowledge workflow'),
  182. operation_id=_('Create knowledge workflow'), # type: ignore
  183. parameters=KnowledgeWorkflowApi.get_parameters(),
  184. responses=KnowledgeWorkflowApi.get_response(),
  185. tags=[_('Knowledge Base')] # type: ignore
  186. )
  187. @has_permissions(
  188. PermissionConstants.KNOWLEDGE_CREATE.get_workspace_permission(),
  189. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(), RoleConstants.USER.get_workspace_role()
  190. )
  191. def post(self, request: Request, workspace_id: str):
  192. return result.success(KnowledgeWorkflowSerializer.Create(
  193. data={'user_id': request.user.id, 'workspace_id': workspace_id}
  194. ).save_workflow(request.data))
  195. class Publish(APIView):
  196. authentication_classes = [TokenAuth]
  197. @extend_schema(
  198. methods=['PUT'],
  199. description=_("Publishing an knowledge"),
  200. summary=_("Publishing an knowledge"),
  201. operation_id=_("Publishing an knowledge"), # type: ignore
  202. parameters=KnowledgeWorkflowApi.get_parameters(),
  203. request=None,
  204. responses=DefaultResultSerializer,
  205. tags=[_('Knowledge')] # type: ignore
  206. )
  207. @has_permissions(PermissionConstants.KNOWLEDGE_WORKFLOW_EDIT.get_workspace_knowledge_permission(),
  208. PermissionConstants.KNOWLEDGE_WORKFLOW_EDIT.get_workspace_permission_workspace_manage_role(),
  209. ViewPermission([RoleConstants.USER.get_workspace_role()],
  210. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  211. CompareConstants.AND),
  212. RoleConstants.WORKSPACE_MANAGE.get_workspace_role())
  213. @log(menu='Knowledge', operate='Publishing an knowledge',
  214. get_operation_object=lambda r, k: get_knowledge_operation_object(k.get('knowledge_id')))
  215. def put(self, request: Request, workspace_id: str, knowledge_id: str):
  216. return result.success(
  217. KnowledgeWorkflowSerializer.Operate(
  218. data={'knowledge_id': knowledge_id, 'user_id': request.user.id,
  219. 'workspace_id': workspace_id, }).publish())
  220. class Export(APIView):
  221. authentication_classes = [TokenAuth]
  222. @extend_schema(
  223. methods=['GET'],
  224. description=_('Export knowledge workflow'),
  225. summary=_('Export knowledge workflow'),
  226. operation_id=_('Export knowledge workflow'), # type: ignore
  227. parameters=KnowledgeWorkflowExportApi.get_parameters(),
  228. request=None,
  229. responses=KnowledgeWorkflowExportApi.get_response(),
  230. tags=[_('Knowledge Base')] # type: ignore
  231. )
  232. @has_permissions(
  233. PermissionConstants.KNOWLEDGE_WORKFLOW_EXPORT.get_workspace_knowledge_permission(),
  234. PermissionConstants.KNOWLEDGE_WORKFLOW_EXPORT.get_workspace_permission_workspace_manage_role(),
  235. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  236. ViewPermission(
  237. [RoleConstants.USER.get_workspace_role()],
  238. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  239. CompareConstants.AND
  240. )
  241. )
  242. @log(menu='Knowledge', operate="Export knowledge workflow",
  243. get_operation_object=lambda r, k: get_knowledge_operation_object(k.get('knowledge_id')),
  244. )
  245. def get(self, request: Request, workspace_id: str, knowledge_id: str):
  246. return KnowledgeWorkflowSerializer.Export(
  247. data={'knowledge_id': knowledge_id, 'user_id': request.user.id, 'workspace_id': workspace_id}
  248. ).export()
  249. class Import(APIView):
  250. authentication_classes = [TokenAuth]
  251. @extend_schema(
  252. methods=['POST'],
  253. description=_('Import knowledge workflow'),
  254. summary=_('Import knowledge workflow'),
  255. operation_id=_('Import knowledge workflow'), # type: ignore
  256. parameters=KnowledgeWorkflowImportApi.get_parameters(),
  257. request=KnowledgeWorkflowImportApi.get_request(),
  258. responses=KnowledgeWorkflowImportApi.get_response(),
  259. tags=[_('Knowledge Base')] # type: ignore
  260. )
  261. @has_permissions(
  262. PermissionConstants.KNOWLEDGE_WORKFLOW_EDIT.get_workspace_knowledge_permission(),
  263. PermissionConstants.KNOWLEDGE_WORKFLOW_EDIT.get_workspace_permission_workspace_manage_role(),
  264. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  265. ViewPermission(
  266. [RoleConstants.USER.get_workspace_role()],
  267. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  268. CompareConstants.AND
  269. )
  270. )
  271. @log(menu='Knowledge', operate="Import knowledge workflow",
  272. get_operation_object=lambda r, k: get_knowledge_operation_object(k.get('knowledge_id')),
  273. )
  274. def post(self, request: Request, workspace_id: str, knowledge_id: str):
  275. is_import_tool = get_is_permissions(request, workspace_id=workspace_id)(
  276. PermissionConstants.TOOL_IMPORT.get_workspace_permission(),
  277. PermissionConstants.TOOL_IMPORT.get_workspace_permission_workspace_manage_role(),
  278. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(), RoleConstants.USER.get_workspace_role()
  279. )
  280. return result.success(KnowledgeWorkflowSerializer.Import(data={
  281. 'knowledge_id': knowledge_id, 'user_id': request.user.id, 'workspace_id': workspace_id
  282. }).import_({'file': request.FILES.get('file')}, is_import_tool))
  283. class Operate(APIView):
  284. authentication_classes = [TokenAuth]
  285. @extend_schema(
  286. methods=['PUT'],
  287. description=_('Edit knowledge workflow'),
  288. summary=_('Edit knowledge workflow'),
  289. operation_id=_('Edit knowledge workflow'), # type: ignore
  290. parameters=KnowledgeWorkflowApi.get_parameters(),
  291. request=KnowledgeWorkflowApi.get_request(),
  292. responses=KnowledgeWorkflowApi.get_response(),
  293. tags=[_('Knowledge Base')] # type: ignore
  294. )
  295. @has_permissions(
  296. PermissionConstants.KNOWLEDGE_WORKFLOW_EDIT.get_workspace_knowledge_permission(),
  297. PermissionConstants.KNOWLEDGE_WORKFLOW_EDIT.get_workspace_permission_workspace_manage_role(),
  298. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  299. ViewPermission(
  300. [RoleConstants.USER.get_workspace_role()],
  301. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  302. CompareConstants.AND
  303. )
  304. )
  305. @log(
  306. menu='Knowledge Base', operate="Modify knowledge workflow",
  307. get_operation_object=lambda r, keywords: get_knowledge_operation_object(keywords.get('knowledge_id')),
  308. )
  309. def put(self, request: Request, workspace_id: str, knowledge_id: str):
  310. return result.success(KnowledgeWorkflowSerializer.Operate(
  311. data={'user_id': request.user.id, 'workspace_id': workspace_id, 'knowledge_id': knowledge_id}
  312. ).edit(request.data))
  313. @extend_schema(
  314. methods=['GET'],
  315. description=_('Get knowledge workflow'),
  316. summary=_('Get knowledge workflow'),
  317. operation_id=_('Get knowledge workflow'), # type: ignore
  318. parameters=KnowledgeWorkflowApi.get_parameters(),
  319. responses=KnowledgeWorkflowApi.get_response(),
  320. tags=[_('Knowledge Base')] # type: ignore
  321. )
  322. @has_permissions(
  323. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_knowledge_permission(),
  324. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_permission_workspace_manage_role(),
  325. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  326. ViewPermission(
  327. [RoleConstants.USER.get_workspace_role()],
  328. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  329. CompareConstants.AND
  330. ),
  331. )
  332. def get(self, request: Request, workspace_id: str, knowledge_id: str):
  333. return result.success(KnowledgeWorkflowSerializer.Operate(
  334. data={'user_id': request.user.id, 'workspace_id': workspace_id, 'knowledge_id': knowledge_id}
  335. ).one())
  336. class KnowledgeWorkflowVersionView(APIView):
  337. authentication_classes = [TokenAuth]
  338. @extend_schema(
  339. methods=['GET'],
  340. description=_('Get knowledge workflow version list'),
  341. summary=_('Get knowledge workflow version list'),
  342. operation_id=_('Get knowledge workflow version list'), # type: ignore
  343. parameters=KnowledgeWorkflowApi.get_parameters(),
  344. responses=KnowledgeWorkflowApi.get_response(),
  345. tags=[_('Knowledge Base')] # type: ignore
  346. )
  347. @has_permissions(
  348. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_knowledge_permission(),
  349. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_permission_workspace_manage_role(),
  350. RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
  351. ViewPermission(
  352. [RoleConstants.USER.get_workspace_role()],
  353. [PermissionConstants.KNOWLEDGE.get_workspace_knowledge_permission()],
  354. CompareConstants.AND
  355. ),
  356. )
  357. def get(self, request: Request, workspace_id: str, knowledge_id: str):
  358. return result.success(KnowledgeWorkflowSerializer.Operate(
  359. data={'user_id': request.user.id, 'workspace_id': workspace_id, 'knowledge_id': knowledge_id}
  360. ).one())
  361. class McpServers(APIView):
  362. authentication_classes = [TokenAuth]
  363. @extend_schema(
  364. methods=['GET'],
  365. description=_("speech to text"),
  366. summary=_("speech to text"),
  367. operation_id=_("speech to text"), # type: ignore
  368. parameters=SpeechToTextAPI.get_parameters(),
  369. request=SpeechToTextAPI.get_request(),
  370. responses=SpeechToTextAPI.get_response(),
  371. tags=[_('Knowledge Base')] # type: ignore
  372. )
  373. @has_permissions(PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_application_permission(),
  374. PermissionConstants.KNOWLEDGE_WORKFLOW_READ.get_workspace_permission_workspace_manage_role(),
  375. ViewPermission([RoleConstants.USER.get_workspace_role()],
  376. [PermissionConstants.KNOWLEDGE.get_workspace_application_permission()],
  377. CompareConstants.AND),
  378. RoleConstants.WORKSPACE_MANAGE.get_workspace_role())
  379. def post(self, request: Request, workspace_id, knowledge_id: str):
  380. return result.success(KnowledgeWorkflowMcpSerializer(
  381. data={'mcp_servers': request.query_params.get('mcp_servers'), 'workspace_id': workspace_id,
  382. 'user_id': request.user.id,
  383. 'knowledge_id': knowledge_id}).get_mcp_servers(request.data))