app.py 16 KB

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