app.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  1. import json
  2. import logging
  3. from datetime import datetime
  4. from flask_login import current_user
  5. from flask_restful import Resource, abort, inputs, marshal_with, reqparse
  6. from werkzeug.exceptions import Forbidden
  7. from constants.languages import demo_model_templates, languages
  8. from constants.model_template import model_templates
  9. from controllers.console import api
  10. from controllers.console.app.error import AppNotFoundError, ProviderNotInitializeError
  11. from controllers.console.setup import setup_required
  12. from controllers.console.wraps import account_initialization_required, cloud_edition_billing_resource_check
  13. from core.errors.error import LLMBadRequestError, ProviderTokenNotInitError
  14. from core.model_manager import ModelManager
  15. from core.model_runtime.entities.model_entities import ModelType
  16. from core.provider_manager import ProviderManager
  17. from events.app_event import app_was_created, app_was_deleted
  18. from extensions.ext_database import db
  19. from fields.app_fields import (
  20. app_detail_fields,
  21. app_detail_fields_with_site,
  22. app_pagination_fields,
  23. template_list_fields,
  24. )
  25. from libs.login import login_required
  26. from models.model import App, AppModelConfig, Site
  27. from services.app_model_config_service import AppModelConfigService
  28. def _get_app(app_id, tenant_id):
  29. app = db.session.query(App).filter(App.id == app_id, App.tenant_id == tenant_id).first()
  30. if not app:
  31. raise AppNotFoundError
  32. return app
  33. class AppListApi(Resource):
  34. @setup_required
  35. @login_required
  36. @account_initialization_required
  37. @marshal_with(app_pagination_fields)
  38. def get(self):
  39. """Get app list"""
  40. parser = reqparse.RequestParser()
  41. parser.add_argument('page', type=inputs.int_range(1, 99999), required=False, default=1, location='args')
  42. parser.add_argument('limit', type=inputs.int_range(1, 100), required=False, default=20, location='args')
  43. parser.add_argument('mode', type=str, choices=['chat', 'completion', 'all'], default='all', location='args', required=False)
  44. parser.add_argument('name', type=str, location='args', required=False)
  45. args = parser.parse_args()
  46. filters = [
  47. App.tenant_id == current_user.current_tenant_id,
  48. App.is_universal == False
  49. ]
  50. if args['mode'] == 'completion':
  51. filters.append(App.mode == 'completion')
  52. elif args['mode'] == 'chat':
  53. filters.append(App.mode == 'chat')
  54. else:
  55. pass
  56. if 'name' in args and args['name']:
  57. filters.append(App.name.ilike(f'%{args["name"]}%'))
  58. app_models = db.paginate(
  59. db.select(App).where(*filters).order_by(App.created_at.desc()),
  60. page=args['page'],
  61. per_page=args['limit'],
  62. error_out=False
  63. )
  64. return app_models
  65. @setup_required
  66. @login_required
  67. @account_initialization_required
  68. @marshal_with(app_detail_fields)
  69. @cloud_edition_billing_resource_check('apps')
  70. def post(self):
  71. """Create app"""
  72. parser = reqparse.RequestParser()
  73. parser.add_argument('name', type=str, required=True, location='json')
  74. parser.add_argument('mode', type=str, choices=['completion', 'chat', 'assistant'], location='json')
  75. parser.add_argument('icon', type=str, location='json')
  76. parser.add_argument('icon_background', type=str, location='json')
  77. parser.add_argument('model_config', type=dict, location='json')
  78. args = parser.parse_args()
  79. # The role of the current user in the ta table must be admin or owner
  80. if not current_user.is_admin_or_owner:
  81. raise Forbidden()
  82. try:
  83. provider_manager = ProviderManager()
  84. default_model_entity = provider_manager.get_default_model(
  85. tenant_id=current_user.current_tenant_id,
  86. model_type=ModelType.LLM
  87. )
  88. except (ProviderTokenNotInitError, LLMBadRequestError):
  89. default_model_entity = None
  90. except Exception as e:
  91. logging.exception(e)
  92. default_model_entity = None
  93. if args['model_config'] is not None:
  94. # validate config
  95. model_config_dict = args['model_config']
  96. # Get provider configurations
  97. provider_manager = ProviderManager()
  98. provider_configurations = provider_manager.get_configurations(current_user.current_tenant_id)
  99. # get available models from provider_configurations
  100. available_models = provider_configurations.get_models(
  101. model_type=ModelType.LLM,
  102. only_active=True
  103. )
  104. # check if model is available
  105. available_models_names = [f'{model.provider.provider}.{model.model}' for model in available_models]
  106. provider_model = f"{model_config_dict['model']['provider']}.{model_config_dict['model']['name']}"
  107. if provider_model not in available_models_names:
  108. if not default_model_entity:
  109. raise ProviderNotInitializeError(
  110. "No Default System Reasoning Model available. Please configure "
  111. "in the Settings -> Model Provider.")
  112. else:
  113. model_config_dict["model"]["provider"] = default_model_entity.provider
  114. model_config_dict["model"]["name"] = default_model_entity.model
  115. model_configuration = AppModelConfigService.validate_configuration(
  116. tenant_id=current_user.current_tenant_id,
  117. account=current_user,
  118. config=model_config_dict,
  119. app_mode=args['mode']
  120. )
  121. app = App(
  122. enable_site=True,
  123. enable_api=True,
  124. is_demo=False,
  125. api_rpm=0,
  126. api_rph=0,
  127. status='normal'
  128. )
  129. app_model_config = AppModelConfig()
  130. app_model_config = app_model_config.from_model_config_dict(model_configuration)
  131. else:
  132. if 'mode' not in args or args['mode'] is None:
  133. abort(400, message="mode is required")
  134. model_config_template = model_templates[args['mode'] + '_default']
  135. app = App(**model_config_template['app'])
  136. app_model_config = AppModelConfig(**model_config_template['model_config'])
  137. # get model provider
  138. model_manager = ModelManager()
  139. try:
  140. model_instance = model_manager.get_default_model_instance(
  141. tenant_id=current_user.current_tenant_id,
  142. model_type=ModelType.LLM
  143. )
  144. except ProviderTokenNotInitError:
  145. model_instance = None
  146. if model_instance:
  147. model_dict = app_model_config.model_dict
  148. model_dict['provider'] = model_instance.provider
  149. model_dict['name'] = model_instance.model
  150. app_model_config.model = json.dumps(model_dict)
  151. app.name = args['name']
  152. app.mode = args['mode']
  153. app.icon = args['icon']
  154. app.icon_background = args['icon_background']
  155. app.tenant_id = current_user.current_tenant_id
  156. db.session.add(app)
  157. db.session.flush()
  158. app_model_config.app_id = app.id
  159. db.session.add(app_model_config)
  160. db.session.flush()
  161. app.app_model_config_id = app_model_config.id
  162. account = current_user
  163. site = Site(
  164. app_id=app.id,
  165. title=app.name,
  166. default_language=account.interface_language,
  167. customize_token_strategy='not_allow',
  168. code=Site.generate_code(16)
  169. )
  170. db.session.add(site)
  171. db.session.commit()
  172. app_was_created.send(app)
  173. return app, 201
  174. class AppTemplateApi(Resource):
  175. @setup_required
  176. @login_required
  177. @account_initialization_required
  178. @marshal_with(template_list_fields)
  179. def get(self):
  180. """Get app demo templates"""
  181. account = current_user
  182. interface_language = account.interface_language
  183. templates = demo_model_templates.get(interface_language)
  184. if not templates:
  185. templates = demo_model_templates.get(languages[0])
  186. return {'data': templates}
  187. class AppApi(Resource):
  188. @setup_required
  189. @login_required
  190. @account_initialization_required
  191. @marshal_with(app_detail_fields_with_site)
  192. def get(self, app_id):
  193. """Get app detail"""
  194. app_id = str(app_id)
  195. app = _get_app(app_id, current_user.current_tenant_id)
  196. return app
  197. @setup_required
  198. @login_required
  199. @account_initialization_required
  200. def delete(self, app_id):
  201. """Delete app"""
  202. app_id = str(app_id)
  203. if not current_user.is_admin_or_owner:
  204. raise Forbidden()
  205. app = _get_app(app_id, current_user.current_tenant_id)
  206. db.session.delete(app)
  207. db.session.commit()
  208. # todo delete related data??
  209. # model_config, site, api_token, conversation, message, message_feedback, message_annotation
  210. app_was_deleted.send(app)
  211. return {'result': 'success'}, 204
  212. class AppNameApi(Resource):
  213. @setup_required
  214. @login_required
  215. @account_initialization_required
  216. @marshal_with(app_detail_fields)
  217. def post(self, app_id):
  218. app_id = str(app_id)
  219. app = _get_app(app_id, current_user.current_tenant_id)
  220. parser = reqparse.RequestParser()
  221. parser.add_argument('name', type=str, required=True, location='json')
  222. args = parser.parse_args()
  223. app.name = args.get('name')
  224. app.updated_at = datetime.utcnow()
  225. db.session.commit()
  226. return app
  227. class AppIconApi(Resource):
  228. @setup_required
  229. @login_required
  230. @account_initialization_required
  231. @marshal_with(app_detail_fields)
  232. def post(self, app_id):
  233. app_id = str(app_id)
  234. app = _get_app(app_id, current_user.current_tenant_id)
  235. parser = reqparse.RequestParser()
  236. parser.add_argument('icon', type=str, location='json')
  237. parser.add_argument('icon_background', type=str, location='json')
  238. args = parser.parse_args()
  239. app.icon = args.get('icon')
  240. app.icon_background = args.get('icon_background')
  241. app.updated_at = datetime.utcnow()
  242. db.session.commit()
  243. return app
  244. class AppSiteStatus(Resource):
  245. @setup_required
  246. @login_required
  247. @account_initialization_required
  248. @marshal_with(app_detail_fields)
  249. def post(self, app_id):
  250. parser = reqparse.RequestParser()
  251. parser.add_argument('enable_site', type=bool, required=True, location='json')
  252. args = parser.parse_args()
  253. app_id = str(app_id)
  254. app = db.session.query(App).filter(App.id == app_id, App.tenant_id == current_user.current_tenant_id).first()
  255. if not app:
  256. raise AppNotFoundError
  257. if args.get('enable_site') == app.enable_site:
  258. return app
  259. app.enable_site = args.get('enable_site')
  260. app.updated_at = datetime.utcnow()
  261. db.session.commit()
  262. return app
  263. class AppApiStatus(Resource):
  264. @setup_required
  265. @login_required
  266. @account_initialization_required
  267. @marshal_with(app_detail_fields)
  268. def post(self, app_id):
  269. parser = reqparse.RequestParser()
  270. parser.add_argument('enable_api', type=bool, required=True, location='json')
  271. args = parser.parse_args()
  272. app_id = str(app_id)
  273. app = _get_app(app_id, current_user.current_tenant_id)
  274. if args.get('enable_api') == app.enable_api:
  275. return app
  276. app.enable_api = args.get('enable_api')
  277. app.updated_at = datetime.utcnow()
  278. db.session.commit()
  279. return app
  280. class AppCopy(Resource):
  281. @staticmethod
  282. def create_app_copy(app):
  283. copy_app = App(
  284. name=app.name + ' copy',
  285. icon=app.icon,
  286. icon_background=app.icon_background,
  287. tenant_id=app.tenant_id,
  288. mode=app.mode,
  289. app_model_config_id=app.app_model_config_id,
  290. enable_site=app.enable_site,
  291. enable_api=app.enable_api,
  292. api_rpm=app.api_rpm,
  293. api_rph=app.api_rph
  294. )
  295. return copy_app
  296. @staticmethod
  297. def create_app_model_config_copy(app_config, copy_app_id):
  298. copy_app_model_config = app_config.copy()
  299. copy_app_model_config.app_id = copy_app_id
  300. return copy_app_model_config
  301. @setup_required
  302. @login_required
  303. @account_initialization_required
  304. @marshal_with(app_detail_fields)
  305. def post(self, app_id):
  306. app_id = str(app_id)
  307. app = _get_app(app_id, current_user.current_tenant_id)
  308. copy_app = self.create_app_copy(app)
  309. db.session.add(copy_app)
  310. app_config = db.session.query(AppModelConfig). \
  311. filter(AppModelConfig.app_id == app_id). \
  312. one_or_none()
  313. if app_config:
  314. copy_app_model_config = self.create_app_model_config_copy(app_config, copy_app.id)
  315. db.session.add(copy_app_model_config)
  316. db.session.commit()
  317. copy_app.app_model_config_id = copy_app_model_config.id
  318. db.session.commit()
  319. return copy_app, 201
  320. api.add_resource(AppListApi, '/apps')
  321. api.add_resource(AppTemplateApi, '/app-templates')
  322. api.add_resource(AppApi, '/apps/<uuid:app_id>')
  323. api.add_resource(AppCopy, '/apps/<uuid:app_id>/copy')
  324. api.add_resource(AppNameApi, '/apps/<uuid:app_id>/name')
  325. api.add_resource(AppIconApi, '/apps/<uuid:app_id>/icon')
  326. api.add_resource(AppSiteStatus, '/apps/<uuid:app_id>/site-enable')
  327. api.add_resource(AppApiStatus, '/apps/<uuid:app_id>/api-enable')