app.py 15 KB

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