tools_transform_service.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. import json
  2. import logging
  3. from typing import Optional, Union
  4. from configs import dify_config
  5. from core.entities.provider_entities import ProviderConfig
  6. from core.tools.entities.api_entities import UserTool, UserToolProvider
  7. from core.tools.entities.common_entities import I18nObject
  8. from core.tools.entities.tool_bundle import ApiToolBundle
  9. from core.tools.entities.tool_entities import (
  10. ApiProviderAuthType,
  11. ToolParameter,
  12. ToolProviderType,
  13. )
  14. from core.tools.provider.api_tool_provider import ApiToolProviderController
  15. from core.tools.provider.builtin_tool_provider import BuiltinToolProviderController
  16. from core.tools.provider.workflow_tool_provider import WorkflowToolProviderController
  17. from core.tools.tool.tool import Tool
  18. from core.tools.tool.workflow_tool import WorkflowTool
  19. from core.tools.utils.configuration import ToolConfigurationManager
  20. from models.tools import ApiToolProvider, BuiltinToolProvider, WorkflowToolProvider
  21. logger = logging.getLogger(__name__)
  22. class ToolTransformService:
  23. @classmethod
  24. def get_tool_provider_icon_url(cls, provider_type: str, provider_name: str, icon: str) -> Union[str, dict]:
  25. """
  26. get tool provider icon url
  27. """
  28. url_prefix = dify_config.CONSOLE_API_URL + "/console/api/workspaces/current/tool-provider/"
  29. if provider_type == ToolProviderType.BUILT_IN.value:
  30. return url_prefix + "builtin/" + provider_name + "/icon"
  31. elif provider_type in [ToolProviderType.API.value, ToolProviderType.WORKFLOW.value]:
  32. try:
  33. return json.loads(icon)
  34. except:
  35. return {"background": "#252525", "content": "\ud83d\ude01"}
  36. return ""
  37. @staticmethod
  38. def repack_provider(provider: Union[dict, UserToolProvider]):
  39. """
  40. repack provider
  41. :param provider: the provider dict
  42. """
  43. if isinstance(provider, dict) and "icon" in provider:
  44. provider["icon"] = ToolTransformService.get_tool_provider_icon_url(
  45. provider_type=provider["type"], provider_name=provider["name"], icon=provider["icon"]
  46. )
  47. elif isinstance(provider, UserToolProvider):
  48. provider.icon = ToolTransformService.get_tool_provider_icon_url(
  49. provider_type=provider.type.value, provider_name=provider.name, icon=provider.icon
  50. )
  51. @classmethod
  52. def builtin_provider_to_user_provider(
  53. cls,
  54. provider_controller: BuiltinToolProviderController,
  55. db_provider: Optional[BuiltinToolProvider],
  56. decrypt_credentials: bool = True,
  57. ) -> UserToolProvider:
  58. """
  59. convert provider controller to user provider
  60. """
  61. result = UserToolProvider(
  62. id=provider_controller.identity.name,
  63. author=provider_controller.identity.author,
  64. name=provider_controller.identity.name,
  65. description=I18nObject(
  66. en_US=provider_controller.identity.description.en_US,
  67. zh_Hans=provider_controller.identity.description.zh_Hans,
  68. pt_BR=provider_controller.identity.description.pt_BR,
  69. ),
  70. icon=provider_controller.identity.icon,
  71. label=I18nObject(
  72. en_US=provider_controller.identity.label.en_US,
  73. zh_Hans=provider_controller.identity.label.zh_Hans,
  74. pt_BR=provider_controller.identity.label.pt_BR,
  75. ),
  76. type=ToolProviderType.BUILT_IN,
  77. masked_credentials={},
  78. is_team_authorization=False,
  79. tools=[],
  80. labels=provider_controller.tool_labels,
  81. )
  82. # get credentials schema
  83. schema = provider_controller.get_credentials_schema()
  84. for name, value in schema.items():
  85. result.masked_credentials[name] = ProviderConfig.Type.default(value.type)
  86. # check if the provider need credentials
  87. if not provider_controller.need_credentials:
  88. result.is_team_authorization = True
  89. result.allow_delete = False
  90. elif db_provider:
  91. result.is_team_authorization = True
  92. if decrypt_credentials:
  93. credentials = db_provider.credentials
  94. # init tool configuration
  95. tool_configuration = ToolConfigurationManager(
  96. tenant_id=db_provider.tenant_id,
  97. config=provider_controller.get_credentials_schema(),
  98. provider_type=provider_controller.provider_type.value,
  99. provider_identity=provider_controller.identity.name
  100. )
  101. # decrypt the credentials and mask the credentials
  102. decrypted_credentials = tool_configuration.decrypt_tool_credentials(credentials=credentials)
  103. masked_credentials = tool_configuration.mask_tool_credentials(credentials=decrypted_credentials)
  104. result.masked_credentials = masked_credentials
  105. result.original_credentials = decrypted_credentials
  106. return result
  107. @staticmethod
  108. def api_provider_to_controller(
  109. db_provider: ApiToolProvider,
  110. ) -> ApiToolProviderController:
  111. """
  112. convert provider controller to user provider
  113. """
  114. # package tool provider controller
  115. controller = ApiToolProviderController.from_db(
  116. db_provider=db_provider,
  117. auth_type=ApiProviderAuthType.API_KEY
  118. if db_provider.credentials["auth_type"] == "api_key"
  119. else ApiProviderAuthType.NONE,
  120. )
  121. return controller
  122. @staticmethod
  123. def workflow_provider_to_controller(db_provider: WorkflowToolProvider) -> WorkflowToolProviderController:
  124. """
  125. convert provider controller to provider
  126. """
  127. return WorkflowToolProviderController.from_db(db_provider)
  128. @staticmethod
  129. def workflow_provider_to_user_provider(
  130. provider_controller: WorkflowToolProviderController, labels: list[str] | None = None
  131. ):
  132. """
  133. convert provider controller to user provider
  134. """
  135. return UserToolProvider(
  136. id=provider_controller.provider_id,
  137. author=provider_controller.identity.author,
  138. name=provider_controller.identity.name,
  139. description=I18nObject(
  140. en_US=provider_controller.identity.description.en_US,
  141. zh_Hans=provider_controller.identity.description.zh_Hans,
  142. ),
  143. icon=provider_controller.identity.icon,
  144. label=I18nObject(
  145. en_US=provider_controller.identity.label.en_US,
  146. zh_Hans=provider_controller.identity.label.zh_Hans,
  147. ),
  148. type=ToolProviderType.WORKFLOW,
  149. masked_credentials={},
  150. is_team_authorization=True,
  151. tools=[],
  152. labels=labels or [],
  153. )
  154. @classmethod
  155. def api_provider_to_user_provider(
  156. cls,
  157. provider_controller: ApiToolProviderController,
  158. db_provider: ApiToolProvider,
  159. decrypt_credentials: bool = True,
  160. labels: list[str] | None = None,
  161. ) -> UserToolProvider:
  162. """
  163. convert provider controller to user provider
  164. """
  165. username = "Anonymous"
  166. try:
  167. username = db_provider.user.name
  168. except Exception as e:
  169. logger.error(f"failed to get user name for api provider {db_provider.id}: {str(e)}")
  170. # add provider into providers
  171. credentials = db_provider.credentials
  172. result = UserToolProvider(
  173. id=db_provider.id,
  174. author=username,
  175. name=db_provider.name,
  176. description=I18nObject(
  177. en_US=db_provider.description,
  178. zh_Hans=db_provider.description,
  179. ),
  180. icon=db_provider.icon,
  181. label=I18nObject(
  182. en_US=db_provider.name,
  183. zh_Hans=db_provider.name,
  184. ),
  185. type=ToolProviderType.API,
  186. masked_credentials={},
  187. is_team_authorization=True,
  188. tools=[],
  189. labels=labels or [],
  190. )
  191. if decrypt_credentials:
  192. # init tool configuration
  193. tool_configuration = ToolConfigurationManager(
  194. tenant_id=db_provider.tenant_id,
  195. config=provider_controller.get_credentials_schema(),
  196. provider_type=provider_controller.provider_type.value,
  197. provider_identity=provider_controller.identity.name
  198. )
  199. # decrypt the credentials and mask the credentials
  200. decrypted_credentials = tool_configuration.decrypt_tool_credentials(credentials=credentials)
  201. masked_credentials = tool_configuration.mask_tool_credentials(credentials=decrypted_credentials)
  202. result.masked_credentials = masked_credentials
  203. return result
  204. @staticmethod
  205. def tool_to_user_tool(
  206. tool: Union[ApiToolBundle, WorkflowTool, Tool],
  207. credentials: dict | None = None,
  208. tenant_id: str | None = None,
  209. labels: list[str] | None = None,
  210. ) -> UserTool:
  211. """
  212. convert tool to user tool
  213. """
  214. if isinstance(tool, Tool):
  215. # fork tool runtime
  216. tool = tool.fork_tool_runtime(
  217. runtime={
  218. "credentials": credentials,
  219. "tenant_id": tenant_id,
  220. }
  221. )
  222. # get tool parameters
  223. parameters = tool.parameters or []
  224. # get tool runtime parameters
  225. runtime_parameters = tool.get_runtime_parameters() or []
  226. # override parameters
  227. current_parameters = parameters.copy()
  228. for runtime_parameter in runtime_parameters:
  229. found = False
  230. for index, parameter in enumerate(current_parameters):
  231. if parameter.name == runtime_parameter.name and parameter.form == runtime_parameter.form:
  232. current_parameters[index] = runtime_parameter
  233. found = True
  234. break
  235. if not found and runtime_parameter.form == ToolParameter.ToolParameterForm.FORM:
  236. current_parameters.append(runtime_parameter)
  237. return UserTool(
  238. author=tool.identity.author,
  239. name=tool.identity.name,
  240. label=tool.identity.label,
  241. description=tool.description.human,
  242. parameters=current_parameters,
  243. labels=labels,
  244. )
  245. if isinstance(tool, ApiToolBundle):
  246. return UserTool(
  247. author=tool.author,
  248. name=tool.operation_id,
  249. label=I18nObject(en_US=tool.operation_id, zh_Hans=tool.operation_id),
  250. description=I18nObject(en_US=tool.summary or "", zh_Hans=tool.summary or ""),
  251. parameters=tool.parameters,
  252. labels=labels,
  253. )