app.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. import uuid
  2. from flask_login import current_user
  3. from flask_restful import Resource, inputs, marshal, marshal_with, reqparse
  4. from werkzeug.exceptions import BadRequest, Forbidden, abort
  5. from controllers.console import api
  6. from controllers.console.app.wraps import get_app_model
  7. from controllers.console.setup import setup_required
  8. from controllers.console.wraps import account_initialization_required, cloud_edition_billing_resource_check
  9. from core.ops.ops_trace_manager import OpsTraceManager
  10. from fields.app_fields import (
  11. app_detail_fields,
  12. app_detail_fields_with_site,
  13. app_pagination_fields,
  14. )
  15. from libs.login import login_required
  16. from services.app_dsl_service import AppDslService
  17. from services.app_service import AppService
  18. ALLOW_CREATE_APP_MODES = ['chat', 'agent-chat', 'advanced-chat', 'workflow', 'completion']
  19. class AppListApi(Resource):
  20. @setup_required
  21. @login_required
  22. @account_initialization_required
  23. def get(self):
  24. """Get app list"""
  25. def uuid_list(value):
  26. try:
  27. return [str(uuid.UUID(v)) for v in value.split(',')]
  28. except ValueError:
  29. abort(400, message="Invalid UUID format in tag_ids.")
  30. parser = reqparse.RequestParser()
  31. parser.add_argument('page', type=inputs.int_range(1, 99999), required=False, default=1, location='args')
  32. parser.add_argument('limit', type=inputs.int_range(1, 100), required=False, default=20, location='args')
  33. parser.add_argument('mode', type=str, choices=['chat', 'workflow', 'agent-chat', 'channel', 'all'], default='all', location='args', required=False)
  34. parser.add_argument('name', type=str, location='args', required=False)
  35. parser.add_argument('tag_ids', type=uuid_list, location='args', required=False)
  36. args = parser.parse_args()
  37. # get app list
  38. app_service = AppService()
  39. app_pagination = app_service.get_paginate_apps(current_user.current_tenant_id, args)
  40. if not app_pagination:
  41. return {'data': [], 'total': 0, 'page': 1, 'limit': 20, 'has_more': False}
  42. return marshal(app_pagination, app_pagination_fields)
  43. @setup_required
  44. @login_required
  45. @account_initialization_required
  46. @marshal_with(app_detail_fields)
  47. @cloud_edition_billing_resource_check('apps')
  48. def post(self):
  49. """Create app"""
  50. parser = reqparse.RequestParser()
  51. parser.add_argument('name', type=str, required=True, location='json')
  52. parser.add_argument('description', type=str, location='json')
  53. parser.add_argument('mode', type=str, choices=ALLOW_CREATE_APP_MODES, location='json')
  54. parser.add_argument('icon_type', type=str, location='json')
  55. parser.add_argument('icon', type=str, location='json')
  56. parser.add_argument('icon_background', type=str, location='json')
  57. args = parser.parse_args()
  58. # The role of the current user in the ta table must be admin, owner, or editor
  59. if not current_user.is_editor:
  60. raise Forbidden()
  61. if 'mode' not in args or args['mode'] is None:
  62. raise BadRequest("mode is required")
  63. app_service = AppService()
  64. app = app_service.create_app(current_user.current_tenant_id, args, current_user)
  65. return app, 201
  66. class AppImportApi(Resource):
  67. @setup_required
  68. @login_required
  69. @account_initialization_required
  70. @marshal_with(app_detail_fields_with_site)
  71. @cloud_edition_billing_resource_check('apps')
  72. def post(self):
  73. """Import app"""
  74. # The role of the current user in the ta table must be admin, owner, or editor
  75. if not current_user.is_editor:
  76. raise Forbidden()
  77. parser = reqparse.RequestParser()
  78. parser.add_argument('data', type=str, required=True, nullable=False, location='json')
  79. parser.add_argument('name', type=str, location='json')
  80. parser.add_argument('description', type=str, location='json')
  81. parser.add_argument('icon_type', type=str, location='json')
  82. parser.add_argument('icon', type=str, location='json')
  83. parser.add_argument('icon_background', type=str, location='json')
  84. args = parser.parse_args()
  85. app = AppDslService.import_and_create_new_app(
  86. tenant_id=current_user.current_tenant_id,
  87. data=args['data'],
  88. args=args,
  89. account=current_user
  90. )
  91. return app, 201
  92. class AppImportFromUrlApi(Resource):
  93. @setup_required
  94. @login_required
  95. @account_initialization_required
  96. @marshal_with(app_detail_fields_with_site)
  97. @cloud_edition_billing_resource_check('apps')
  98. def post(self):
  99. """Import app from url"""
  100. # The role of the current user in the ta table must be admin, owner, or editor
  101. if not current_user.is_editor:
  102. raise Forbidden()
  103. parser = reqparse.RequestParser()
  104. parser.add_argument('url', type=str, required=True, nullable=False, location='json')
  105. parser.add_argument('name', type=str, location='json')
  106. parser.add_argument('description', type=str, location='json')
  107. parser.add_argument('icon', type=str, location='json')
  108. parser.add_argument('icon_background', type=str, location='json')
  109. args = parser.parse_args()
  110. app = AppDslService.import_and_create_new_app_from_url(
  111. tenant_id=current_user.current_tenant_id,
  112. url=args['url'],
  113. args=args,
  114. account=current_user
  115. )
  116. return app, 201
  117. class AppApi(Resource):
  118. @setup_required
  119. @login_required
  120. @account_initialization_required
  121. @get_app_model
  122. @marshal_with(app_detail_fields_with_site)
  123. def get(self, app_model):
  124. """Get app detail"""
  125. app_service = AppService()
  126. app_model = app_service.get_app(app_model)
  127. return app_model
  128. @setup_required
  129. @login_required
  130. @account_initialization_required
  131. @get_app_model
  132. @marshal_with(app_detail_fields_with_site)
  133. def put(self, app_model):
  134. """Update app"""
  135. # The role of the current user in the ta table must be admin, owner, or editor
  136. if not current_user.is_editor:
  137. raise Forbidden()
  138. parser = reqparse.RequestParser()
  139. parser.add_argument('name', type=str, required=True, nullable=False, location='json')
  140. parser.add_argument('description', type=str, location='json')
  141. parser.add_argument('icon_type', type=str, location='json')
  142. parser.add_argument('icon', type=str, location='json')
  143. parser.add_argument('icon_background', type=str, location='json')
  144. parser.add_argument('max_active_requests', type=int, location='json')
  145. args = parser.parse_args()
  146. app_service = AppService()
  147. app_model = app_service.update_app(app_model, args)
  148. return app_model
  149. @setup_required
  150. @login_required
  151. @account_initialization_required
  152. @get_app_model
  153. def delete(self, app_model):
  154. """Delete app"""
  155. # The role of the current user in the ta table must be admin, owner, or editor
  156. if not current_user.is_editor:
  157. raise Forbidden()
  158. app_service = AppService()
  159. app_service.delete_app(app_model)
  160. return {'result': 'success'}, 204
  161. class AppCopyApi(Resource):
  162. @setup_required
  163. @login_required
  164. @account_initialization_required
  165. @get_app_model
  166. @marshal_with(app_detail_fields_with_site)
  167. def post(self, app_model):
  168. """Copy app"""
  169. # The role of the current user in the ta table must be admin, owner, or editor
  170. if not current_user.is_editor:
  171. raise Forbidden()
  172. parser = reqparse.RequestParser()
  173. parser.add_argument('name', type=str, location='json')
  174. parser.add_argument('description', type=str, location='json')
  175. parser.add_argument('icon_type', type=str, location='json')
  176. parser.add_argument('icon', type=str, location='json')
  177. parser.add_argument('icon_background', type=str, location='json')
  178. args = parser.parse_args()
  179. data = AppDslService.export_dsl(app_model=app_model, include_secret=True)
  180. app = AppDslService.import_and_create_new_app(
  181. tenant_id=current_user.current_tenant_id,
  182. data=data,
  183. args=args,
  184. account=current_user
  185. )
  186. return app, 201
  187. class AppExportApi(Resource):
  188. @setup_required
  189. @login_required
  190. @account_initialization_required
  191. @get_app_model
  192. def get(self, app_model):
  193. """Export app"""
  194. # The role of the current user in the ta table must be admin, owner, or editor
  195. if not current_user.is_editor:
  196. raise Forbidden()
  197. # Add include_secret params
  198. parser = reqparse.RequestParser()
  199. parser.add_argument('include_secret', type=inputs.boolean, default=False, location='args')
  200. args = parser.parse_args()
  201. return {
  202. "data": AppDslService.export_dsl(app_model=app_model, include_secret=args['include_secret'])
  203. }
  204. class AppNameApi(Resource):
  205. @setup_required
  206. @login_required
  207. @account_initialization_required
  208. @get_app_model
  209. @marshal_with(app_detail_fields)
  210. def post(self, app_model):
  211. # The role of the current user in the ta table must be admin, owner, or editor
  212. if not current_user.is_editor:
  213. raise Forbidden()
  214. parser = reqparse.RequestParser()
  215. parser.add_argument('name', type=str, required=True, location='json')
  216. args = parser.parse_args()
  217. app_service = AppService()
  218. app_model = app_service.update_app_name(app_model, args.get('name'))
  219. return app_model
  220. class AppIconApi(Resource):
  221. @setup_required
  222. @login_required
  223. @account_initialization_required
  224. @get_app_model
  225. @marshal_with(app_detail_fields)
  226. def post(self, app_model):
  227. # The role of the current user in the ta table must be admin, owner, or editor
  228. if not current_user.is_editor:
  229. raise Forbidden()
  230. parser = reqparse.RequestParser()
  231. parser.add_argument('icon', type=str, location='json')
  232. parser.add_argument('icon_background', type=str, location='json')
  233. args = parser.parse_args()
  234. app_service = AppService()
  235. app_model = app_service.update_app_icon(app_model, args.get('icon'), args.get('icon_background'))
  236. return app_model
  237. class AppSiteStatus(Resource):
  238. @setup_required
  239. @login_required
  240. @account_initialization_required
  241. @get_app_model
  242. @marshal_with(app_detail_fields)
  243. def post(self, app_model):
  244. # The role of the current user in the ta table must be admin, owner, or editor
  245. if not current_user.is_editor:
  246. raise Forbidden()
  247. parser = reqparse.RequestParser()
  248. parser.add_argument('enable_site', type=bool, required=True, location='json')
  249. args = parser.parse_args()
  250. app_service = AppService()
  251. app_model = app_service.update_app_site_status(app_model, args.get('enable_site'))
  252. return app_model
  253. class AppApiStatus(Resource):
  254. @setup_required
  255. @login_required
  256. @account_initialization_required
  257. @get_app_model
  258. @marshal_with(app_detail_fields)
  259. def post(self, app_model):
  260. # The role of the current user in the ta table must be admin or owner
  261. if not current_user.is_admin_or_owner:
  262. raise Forbidden()
  263. parser = reqparse.RequestParser()
  264. parser.add_argument('enable_api', type=bool, required=True, location='json')
  265. args = parser.parse_args()
  266. app_service = AppService()
  267. app_model = app_service.update_app_api_status(app_model, args.get('enable_api'))
  268. return app_model
  269. class AppTraceApi(Resource):
  270. @setup_required
  271. @login_required
  272. @account_initialization_required
  273. def get(self, app_id):
  274. """Get app trace"""
  275. app_trace_config = OpsTraceManager.get_app_tracing_config(
  276. app_id=app_id
  277. )
  278. return app_trace_config
  279. @setup_required
  280. @login_required
  281. @account_initialization_required
  282. def post(self, app_id):
  283. # add app trace
  284. if not current_user.is_admin_or_owner:
  285. raise Forbidden()
  286. parser = reqparse.RequestParser()
  287. parser.add_argument('enabled', type=bool, required=True, location='json')
  288. parser.add_argument('tracing_provider', type=str, required=True, location='json')
  289. args = parser.parse_args()
  290. OpsTraceManager.update_app_tracing_config(
  291. app_id=app_id,
  292. enabled=args['enabled'],
  293. tracing_provider=args['tracing_provider'],
  294. )
  295. return {"result": "success"}
  296. api.add_resource(AppListApi, '/apps')
  297. api.add_resource(AppImportApi, '/apps/import')
  298. api.add_resource(AppImportFromUrlApi, '/apps/import/url')
  299. api.add_resource(AppApi, '/apps/<uuid:app_id>')
  300. api.add_resource(AppCopyApi, '/apps/<uuid:app_id>/copy')
  301. api.add_resource(AppExportApi, '/apps/<uuid:app_id>/export')
  302. api.add_resource(AppNameApi, '/apps/<uuid:app_id>/name')
  303. api.add_resource(AppIconApi, '/apps/<uuid:app_id>/icon')
  304. api.add_resource(AppSiteStatus, '/apps/<uuid:app_id>/site-enable')
  305. api.add_resource(AppApiStatus, '/apps/<uuid:app_id>/api-enable')
  306. api.add_resource(AppTraceApi, '/apps/<uuid:app_id>/trace')