app.py 13 KB

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