app.py 13 KB

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