providers.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  1. # -*- coding:utf-8 -*-
  2. import base64
  3. import json
  4. import logging
  5. from flask_login import login_required, current_user
  6. from flask_restful import Resource, reqparse, abort
  7. from werkzeug.exceptions import Forbidden
  8. from controllers.console import api
  9. from controllers.console.setup import setup_required
  10. from controllers.console.wraps import account_initialization_required
  11. from core.llm.provider.errors import ValidateFailedError
  12. from extensions.ext_database import db
  13. from libs import rsa
  14. from models.provider import Provider, ProviderType, ProviderName
  15. from services.provider_service import ProviderService
  16. class ProviderListApi(Resource):
  17. @setup_required
  18. @login_required
  19. @account_initialization_required
  20. def get(self):
  21. tenant_id = current_user.current_tenant_id
  22. """
  23. If the type is AZURE_OPENAI, decode and return the four fields of azure_api_type, azure_api_version:,
  24. azure_api_base, azure_api_key as an object, where azure_api_key displays the first 6 bits in plaintext, and the
  25. rest is replaced by * and the last two bits are displayed in plaintext
  26. If the type is other, decode and return the Token field directly, the field displays the first 6 bits in
  27. plaintext, the rest is replaced by * and the last two bits are displayed in plaintext
  28. """
  29. ProviderService.init_supported_provider(current_user.current_tenant, "cloud")
  30. providers = Provider.query.filter_by(tenant_id=tenant_id).all()
  31. provider_list = [
  32. {
  33. 'provider_name': p.provider_name,
  34. 'provider_type': p.provider_type,
  35. 'is_valid': p.is_valid,
  36. 'last_used': p.last_used,
  37. 'is_enabled': p.is_enabled,
  38. **({
  39. 'quota_type': p.quota_type,
  40. 'quota_limit': p.quota_limit,
  41. 'quota_used': p.quota_used
  42. } if p.provider_type == ProviderType.SYSTEM.value else {}),
  43. 'token': ProviderService.get_obfuscated_api_key(current_user.current_tenant,
  44. ProviderName(p.provider_name))
  45. }
  46. for p in providers
  47. ]
  48. return provider_list
  49. class ProviderTokenApi(Resource):
  50. @setup_required
  51. @login_required
  52. @account_initialization_required
  53. def post(self, provider):
  54. if provider not in [p.value for p in ProviderName]:
  55. abort(404)
  56. # The role of the current user in the ta table must be admin or owner
  57. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  58. logging.log(logging.ERROR,
  59. f'User {current_user.id} is not authorized to update provider token, current_role is {current_user.current_tenant.current_role}')
  60. raise Forbidden()
  61. parser = reqparse.RequestParser()
  62. parser.add_argument('token', type=ProviderService.get_token_type(
  63. tenant=current_user.current_tenant,
  64. provider_name=ProviderName(provider)
  65. ), required=True, nullable=False, location='json')
  66. args = parser.parse_args()
  67. if args['token']:
  68. try:
  69. ProviderService.validate_provider_configs(
  70. tenant=current_user.current_tenant,
  71. provider_name=ProviderName(provider),
  72. configs=args['token']
  73. )
  74. token_is_valid = True
  75. except ValidateFailedError as ex:
  76. raise ValueError(str(ex))
  77. base64_encrypted_token = ProviderService.get_encrypted_token(
  78. tenant=current_user.current_tenant,
  79. provider_name=ProviderName(provider),
  80. configs=args['token']
  81. )
  82. else:
  83. base64_encrypted_token = None
  84. token_is_valid = False
  85. tenant = current_user.current_tenant
  86. provider_model = db.session.query(Provider).filter(
  87. Provider.tenant_id == tenant.id,
  88. Provider.provider_name == provider,
  89. Provider.provider_type == ProviderType.CUSTOM.value
  90. ).first()
  91. # Only allow updating token for CUSTOM provider type
  92. if provider_model:
  93. provider_model.encrypted_config = base64_encrypted_token
  94. provider_model.is_valid = token_is_valid
  95. else:
  96. provider_model = Provider(tenant_id=tenant.id, provider_name=provider,
  97. provider_type=ProviderType.CUSTOM.value,
  98. encrypted_config=base64_encrypted_token,
  99. is_valid=token_is_valid)
  100. db.session.add(provider_model)
  101. if provider_model.is_valid:
  102. other_providers = db.session.query(Provider).filter(
  103. Provider.tenant_id == tenant.id,
  104. Provider.provider_name != provider,
  105. Provider.provider_type == ProviderType.CUSTOM.value
  106. ).all()
  107. for other_provider in other_providers:
  108. other_provider.is_valid = False
  109. db.session.commit()
  110. if provider in [ProviderName.ANTHROPIC.value, ProviderName.AZURE_OPENAI.value, ProviderName.COHERE.value,
  111. ProviderName.HUGGINGFACEHUB.value]:
  112. return {'result': 'success', 'warning': 'MOCK: This provider is not supported yet.'}, 201
  113. return {'result': 'success'}, 201
  114. class ProviderTokenValidateApi(Resource):
  115. @setup_required
  116. @login_required
  117. @account_initialization_required
  118. def post(self, provider):
  119. if provider not in [p.value for p in ProviderName]:
  120. abort(404)
  121. parser = reqparse.RequestParser()
  122. parser.add_argument('token', type=ProviderService.get_token_type(
  123. tenant=current_user.current_tenant,
  124. provider_name=ProviderName(provider)
  125. ), required=True, nullable=False, location='json')
  126. args = parser.parse_args()
  127. # todo: remove this when the provider is supported
  128. if provider in [ProviderName.ANTHROPIC.value, ProviderName.COHERE.value,
  129. ProviderName.HUGGINGFACEHUB.value]:
  130. return {'result': 'success', 'warning': 'MOCK: This provider is not supported yet.'}
  131. result = True
  132. error = None
  133. try:
  134. ProviderService.validate_provider_configs(
  135. tenant=current_user.current_tenant,
  136. provider_name=ProviderName(provider),
  137. configs=args['token']
  138. )
  139. except ValidateFailedError as e:
  140. result = False
  141. error = str(e)
  142. response = {'result': 'success' if result else 'error'}
  143. if not result:
  144. response['error'] = error
  145. return response
  146. class ProviderSystemApi(Resource):
  147. @setup_required
  148. @login_required
  149. @account_initialization_required
  150. def put(self, provider):
  151. if provider not in [p.value for p in ProviderName]:
  152. abort(404)
  153. parser = reqparse.RequestParser()
  154. parser.add_argument('is_enabled', type=bool, required=True, location='json')
  155. args = parser.parse_args()
  156. tenant = current_user.current_tenant_id
  157. provider_model = Provider.query.filter_by(tenant_id=tenant.id, provider_name=provider).first()
  158. if provider_model and provider_model.provider_type == ProviderType.SYSTEM.value:
  159. provider_model.is_valid = args['is_enabled']
  160. db.session.commit()
  161. elif not provider_model:
  162. ProviderService.create_system_provider(tenant, provider, args['is_enabled'])
  163. else:
  164. abort(403)
  165. return {'result': 'success'}
  166. @setup_required
  167. @login_required
  168. @account_initialization_required
  169. def get(self, provider):
  170. if provider not in [p.value for p in ProviderName]:
  171. abort(404)
  172. # The role of the current user in the ta table must be admin or owner
  173. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  174. raise Forbidden()
  175. provider_model = db.session.query(Provider).filter(Provider.tenant_id == current_user.current_tenant_id,
  176. Provider.provider_name == provider,
  177. Provider.provider_type == ProviderType.SYSTEM.value).first()
  178. system_model = None
  179. if provider_model:
  180. system_model = {
  181. 'result': 'success',
  182. 'provider': {
  183. 'provider_name': provider_model.provider_name,
  184. 'provider_type': provider_model.provider_type,
  185. 'is_valid': provider_model.is_valid,
  186. 'last_used': provider_model.last_used,
  187. 'is_enabled': provider_model.is_enabled,
  188. 'quota_type': provider_model.quota_type,
  189. 'quota_limit': provider_model.quota_limit,
  190. 'quota_used': provider_model.quota_used
  191. }
  192. }
  193. else:
  194. abort(404)
  195. return system_model
  196. api.add_resource(ProviderTokenApi, '/providers/<provider>/token',
  197. endpoint='current_providers_token') # Deprecated
  198. api.add_resource(ProviderTokenValidateApi, '/providers/<provider>/token-validate',
  199. endpoint='current_providers_token_validate') # Deprecated
  200. api.add_resource(ProviderTokenApi, '/workspaces/current/providers/<provider>/token',
  201. endpoint='workspaces_current_providers_token') # PUT for updating provider token
  202. api.add_resource(ProviderTokenValidateApi, '/workspaces/current/providers/<provider>/token-validate',
  203. endpoint='workspaces_current_providers_token_validate') # POST for validating provider token
  204. api.add_resource(ProviderListApi, '/workspaces/current/providers') # GET for getting providers list
  205. api.add_resource(ProviderSystemApi, '/workspaces/current/providers/<provider>/system',
  206. endpoint='workspaces_current_providers_system') # GET for getting provider quota, PUT for updating provider status