app.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  1. # -*- coding:utf-8 -*-
  2. import json
  3. import logging
  4. from datetime import datetime
  5. from flask_login import login_required, current_user
  6. from flask_restful import Resource, reqparse, fields, marshal_with, abort, inputs
  7. from werkzeug.exceptions import Forbidden
  8. from constants.model_template import model_templates, demo_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
  13. from core.model_providers.error import ProviderTokenNotInitError, LLMBadRequestError
  14. from core.model_providers.model_factory import ModelFactory
  15. from core.model_providers.model_provider_factory import ModelProviderFactory
  16. from core.model_providers.models.entity.model_params import ModelType
  17. from events.app_event import app_was_created, app_was_deleted
  18. from libs.helper import TimestampField
  19. from extensions.ext_database import db
  20. from models.model import App, AppModelConfig, Site
  21. from services.app_model_config_service import AppModelConfigService
  22. model_config_fields = {
  23. 'opening_statement': fields.String,
  24. 'suggested_questions': fields.Raw(attribute='suggested_questions_list'),
  25. 'suggested_questions_after_answer': fields.Raw(attribute='suggested_questions_after_answer_dict'),
  26. 'speech_to_text': fields.Raw(attribute='speech_to_text_dict'),
  27. 'more_like_this': fields.Raw(attribute='more_like_this_dict'),
  28. 'sensitive_word_avoidance': fields.Raw(attribute='sensitive_word_avoidance_dict'),
  29. 'model': fields.Raw(attribute='model_dict'),
  30. 'user_input_form': fields.Raw(attribute='user_input_form_list'),
  31. 'pre_prompt': fields.String,
  32. 'agent_mode': fields.Raw(attribute='agent_mode_dict'),
  33. }
  34. app_detail_fields = {
  35. 'id': fields.String,
  36. 'name': fields.String,
  37. 'mode': fields.String,
  38. 'icon': fields.String,
  39. 'icon_background': fields.String,
  40. 'enable_site': fields.Boolean,
  41. 'enable_api': fields.Boolean,
  42. 'api_rpm': fields.Integer,
  43. 'api_rph': fields.Integer,
  44. 'is_demo': fields.Boolean,
  45. 'model_config': fields.Nested(model_config_fields, attribute='app_model_config'),
  46. 'created_at': TimestampField
  47. }
  48. def _get_app(app_id, tenant_id):
  49. app = db.session.query(App).filter(App.id == app_id, App.tenant_id == tenant_id).first()
  50. if not app:
  51. raise AppNotFoundError
  52. return app
  53. class AppListApi(Resource):
  54. prompt_config_fields = {
  55. 'prompt_template': fields.String,
  56. }
  57. model_config_partial_fields = {
  58. 'model': fields.Raw(attribute='model_dict'),
  59. 'pre_prompt': fields.String,
  60. }
  61. app_partial_fields = {
  62. 'id': fields.String,
  63. 'name': fields.String,
  64. 'mode': fields.String,
  65. 'icon': fields.String,
  66. 'icon_background': fields.String,
  67. 'enable_site': fields.Boolean,
  68. 'enable_api': fields.Boolean,
  69. 'is_demo': fields.Boolean,
  70. 'model_config': fields.Nested(model_config_partial_fields, attribute='app_model_config'),
  71. 'created_at': TimestampField
  72. }
  73. app_pagination_fields = {
  74. 'page': fields.Integer,
  75. 'limit': fields.Integer(attribute='per_page'),
  76. 'total': fields.Integer,
  77. 'has_more': fields.Boolean(attribute='has_next'),
  78. 'data': fields.List(fields.Nested(app_partial_fields), attribute='items')
  79. }
  80. @setup_required
  81. @login_required
  82. @account_initialization_required
  83. @marshal_with(app_pagination_fields)
  84. def get(self):
  85. """Get app list"""
  86. parser = reqparse.RequestParser()
  87. parser.add_argument('page', type=inputs.int_range(1, 99999), required=False, default=1, location='args')
  88. parser.add_argument('limit', type=inputs.int_range(1, 100), required=False, default=20, location='args')
  89. args = parser.parse_args()
  90. app_models = db.paginate(
  91. db.select(App).where(App.tenant_id == current_user.current_tenant_id,
  92. App.is_universal == False).order_by(App.created_at.desc()),
  93. page=args['page'],
  94. per_page=args['limit'],
  95. error_out=False)
  96. return app_models
  97. @setup_required
  98. @login_required
  99. @account_initialization_required
  100. @marshal_with(app_detail_fields)
  101. def post(self):
  102. """Create app"""
  103. parser = reqparse.RequestParser()
  104. parser.add_argument('name', type=str, required=True, location='json')
  105. parser.add_argument('mode', type=str, choices=['completion', 'chat'], location='json')
  106. parser.add_argument('icon', type=str, location='json')
  107. parser.add_argument('icon_background', type=str, location='json')
  108. parser.add_argument('model_config', type=dict, location='json')
  109. args = parser.parse_args()
  110. # The role of the current user in the ta table must be admin or owner
  111. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  112. raise Forbidden()
  113. try:
  114. default_model = ModelFactory.get_text_generation_model(
  115. tenant_id=current_user.current_tenant_id
  116. )
  117. except (ProviderTokenNotInitError, LLMBadRequestError):
  118. default_model = None
  119. except Exception as e:
  120. logging.exception(e)
  121. default_model = None
  122. if args['model_config'] is not None:
  123. # validate config
  124. model_config_dict = args['model_config']
  125. # get model provider
  126. model_provider = ModelProviderFactory.get_preferred_model_provider(
  127. current_user.current_tenant_id,
  128. model_config_dict["model"]["provider"]
  129. )
  130. if not model_provider:
  131. if not default_model:
  132. raise ProviderNotInitializeError(
  133. f"No Default System Reasoning Model available. Please configure "
  134. f"in the Settings -> Model Provider.")
  135. else:
  136. model_config_dict["model"]["provider"] = default_model.model_provider.provider_name
  137. model_config_dict["model"]["name"] = default_model.name
  138. model_configuration = AppModelConfigService.validate_configuration(
  139. tenant_id=current_user.current_tenant_id,
  140. account=current_user,
  141. config=model_config_dict
  142. )
  143. app = App(
  144. enable_site=True,
  145. enable_api=True,
  146. is_demo=False,
  147. api_rpm=0,
  148. api_rph=0,
  149. status='normal'
  150. )
  151. app_model_config = AppModelConfig()
  152. app_model_config = app_model_config.from_model_config_dict(model_configuration)
  153. else:
  154. if 'mode' not in args or args['mode'] is None:
  155. abort(400, message="mode is required")
  156. model_config_template = model_templates[args['mode'] + '_default']
  157. app = App(**model_config_template['app'])
  158. app_model_config = AppModelConfig(**model_config_template['model_config'])
  159. # get model provider
  160. model_provider = ModelProviderFactory.get_preferred_model_provider(
  161. current_user.current_tenant_id,
  162. app_model_config.model_dict["provider"]
  163. )
  164. if not model_provider:
  165. if not default_model:
  166. raise ProviderNotInitializeError(
  167. f"No Default System Reasoning Model available. Please configure "
  168. f"in the Settings -> Model Provider.")
  169. else:
  170. model_dict = app_model_config.model_dict
  171. model_dict['provider'] = default_model.model_provider.provider_name
  172. model_dict['name'] = default_model.name
  173. app_model_config.model = json.dumps(model_dict)
  174. app.name = args['name']
  175. app.mode = args['mode']
  176. app.icon = args['icon']
  177. app.icon_background = args['icon_background']
  178. app.tenant_id = current_user.current_tenant_id
  179. db.session.add(app)
  180. db.session.flush()
  181. app_model_config.app_id = app.id
  182. db.session.add(app_model_config)
  183. db.session.flush()
  184. app.app_model_config_id = app_model_config.id
  185. account = current_user
  186. site = Site(
  187. app_id=app.id,
  188. title=app.name,
  189. default_language=account.interface_language,
  190. customize_token_strategy='not_allow',
  191. code=Site.generate_code(16)
  192. )
  193. db.session.add(site)
  194. db.session.commit()
  195. app_was_created.send(app)
  196. return app, 201
  197. class AppTemplateApi(Resource):
  198. template_fields = {
  199. 'name': fields.String,
  200. 'icon': fields.String,
  201. 'icon_background': fields.String,
  202. 'description': fields.String,
  203. 'mode': fields.String,
  204. 'model_config': fields.Nested(model_config_fields),
  205. }
  206. template_list_fields = {
  207. 'data': fields.List(fields.Nested(template_fields)),
  208. }
  209. @setup_required
  210. @login_required
  211. @account_initialization_required
  212. @marshal_with(template_list_fields)
  213. def get(self):
  214. """Get app demo templates"""
  215. account = current_user
  216. interface_language = account.interface_language
  217. templates = demo_model_templates.get(interface_language)
  218. if not templates:
  219. templates = demo_model_templates.get('en-US')
  220. return {'data': templates}
  221. class AppApi(Resource):
  222. site_fields = {
  223. 'access_token': fields.String(attribute='code'),
  224. 'code': fields.String,
  225. 'title': fields.String,
  226. 'icon': fields.String,
  227. 'icon_background': fields.String,
  228. 'description': fields.String,
  229. 'default_language': fields.String,
  230. 'customize_domain': fields.String,
  231. 'copyright': fields.String,
  232. 'privacy_policy': fields.String,
  233. 'customize_token_strategy': fields.String,
  234. 'prompt_public': fields.Boolean,
  235. 'app_base_url': fields.String,
  236. }
  237. app_detail_fields_with_site = {
  238. 'id': fields.String,
  239. 'name': fields.String,
  240. 'mode': fields.String,
  241. 'icon': fields.String,
  242. 'icon_background': fields.String,
  243. 'enable_site': fields.Boolean,
  244. 'enable_api': fields.Boolean,
  245. 'api_rpm': fields.Integer,
  246. 'api_rph': fields.Integer,
  247. 'is_demo': fields.Boolean,
  248. 'model_config': fields.Nested(model_config_fields, attribute='app_model_config'),
  249. 'site': fields.Nested(site_fields),
  250. 'api_base_url': fields.String,
  251. 'created_at': TimestampField
  252. }
  253. @setup_required
  254. @login_required
  255. @account_initialization_required
  256. @marshal_with(app_detail_fields_with_site)
  257. def get(self, app_id):
  258. """Get app detail"""
  259. app_id = str(app_id)
  260. app = _get_app(app_id, current_user.current_tenant_id)
  261. return app
  262. @setup_required
  263. @login_required
  264. @account_initialization_required
  265. def delete(self, app_id):
  266. """Delete app"""
  267. app_id = str(app_id)
  268. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  269. raise Forbidden()
  270. app = _get_app(app_id, current_user.current_tenant_id)
  271. db.session.delete(app)
  272. db.session.commit()
  273. # todo delete related data??
  274. # model_config, site, api_token, conversation, message, message_feedback, message_annotation
  275. app_was_deleted.send(app)
  276. return {'result': 'success'}, 204
  277. class AppNameApi(Resource):
  278. @setup_required
  279. @login_required
  280. @account_initialization_required
  281. @marshal_with(app_detail_fields)
  282. def post(self, app_id):
  283. app_id = str(app_id)
  284. app = _get_app(app_id, current_user.current_tenant_id)
  285. parser = reqparse.RequestParser()
  286. parser.add_argument('name', type=str, required=True, location='json')
  287. args = parser.parse_args()
  288. app.name = args.get('name')
  289. app.updated_at = datetime.utcnow()
  290. db.session.commit()
  291. return app
  292. class AppIconApi(Resource):
  293. @setup_required
  294. @login_required
  295. @account_initialization_required
  296. @marshal_with(app_detail_fields)
  297. def post(self, app_id):
  298. app_id = str(app_id)
  299. app = _get_app(app_id, current_user.current_tenant_id)
  300. parser = reqparse.RequestParser()
  301. parser.add_argument('icon', type=str, location='json')
  302. parser.add_argument('icon_background', type=str, location='json')
  303. args = parser.parse_args()
  304. app.icon = args.get('icon')
  305. app.icon_background = args.get('icon_background')
  306. app.updated_at = datetime.utcnow()
  307. db.session.commit()
  308. return app
  309. class AppSiteStatus(Resource):
  310. @setup_required
  311. @login_required
  312. @account_initialization_required
  313. @marshal_with(app_detail_fields)
  314. def post(self, app_id):
  315. parser = reqparse.RequestParser()
  316. parser.add_argument('enable_site', type=bool, required=True, location='json')
  317. args = parser.parse_args()
  318. app_id = str(app_id)
  319. app = db.session.query(App).filter(App.id == app_id, App.tenant_id == current_user.current_tenant_id).first()
  320. if not app:
  321. raise AppNotFoundError
  322. if args.get('enable_site') == app.enable_site:
  323. return app
  324. app.enable_site = args.get('enable_site')
  325. app.updated_at = datetime.utcnow()
  326. db.session.commit()
  327. return app
  328. class AppApiStatus(Resource):
  329. @setup_required
  330. @login_required
  331. @account_initialization_required
  332. @marshal_with(app_detail_fields)
  333. def post(self, app_id):
  334. parser = reqparse.RequestParser()
  335. parser.add_argument('enable_api', type=bool, required=True, location='json')
  336. args = parser.parse_args()
  337. app_id = str(app_id)
  338. app = _get_app(app_id, current_user.current_tenant_id)
  339. if args.get('enable_api') == app.enable_api:
  340. return app
  341. app.enable_api = args.get('enable_api')
  342. app.updated_at = datetime.utcnow()
  343. db.session.commit()
  344. return app
  345. class AppCopy(Resource):
  346. @staticmethod
  347. def create_app_copy(app):
  348. copy_app = App(
  349. name=app.name + ' copy',
  350. icon=app.icon,
  351. icon_background=app.icon_background,
  352. tenant_id=app.tenant_id,
  353. mode=app.mode,
  354. app_model_config_id=app.app_model_config_id,
  355. enable_site=app.enable_site,
  356. enable_api=app.enable_api,
  357. api_rpm=app.api_rpm,
  358. api_rph=app.api_rph
  359. )
  360. return copy_app
  361. @staticmethod
  362. def create_app_model_config_copy(app_config, copy_app_id):
  363. copy_app_model_config = app_config.copy()
  364. copy_app_model_config.app_id = copy_app_id
  365. return copy_app_model_config
  366. @setup_required
  367. @login_required
  368. @account_initialization_required
  369. @marshal_with(app_detail_fields)
  370. def post(self, app_id):
  371. app_id = str(app_id)
  372. app = _get_app(app_id, current_user.current_tenant_id)
  373. copy_app = self.create_app_copy(app)
  374. db.session.add(copy_app)
  375. app_config = db.session.query(AppModelConfig). \
  376. filter(AppModelConfig.app_id == app_id). \
  377. one_or_none()
  378. if app_config:
  379. copy_app_model_config = self.create_app_model_config_copy(app_config, copy_app.id)
  380. db.session.add(copy_app_model_config)
  381. db.session.commit()
  382. copy_app.app_model_config_id = copy_app_model_config.id
  383. db.session.commit()
  384. return copy_app, 201
  385. api.add_resource(AppListApi, '/apps')
  386. api.add_resource(AppTemplateApi, '/app-templates')
  387. api.add_resource(AppApi, '/apps/<uuid:app_id>')
  388. api.add_resource(AppCopy, '/apps/<uuid:app_id>/copy')
  389. api.add_resource(AppNameApi, '/apps/<uuid:app_id>/name')
  390. api.add_resource(AppIconApi, '/apps/<uuid:app_id>/icon')
  391. api.add_resource(AppSiteStatus, '/apps/<uuid:app_id>/site-enable')
  392. api.add_resource(AppApiStatus, '/apps/<uuid:app_id>/api-enable')