mirror of
http://112.124.100.131/huang.ze/ebiz-dify-ai.git
synced 2025-12-11 03:46:52 +08:00
chore(api/core): apply ruff reformatting (#7624)
This commit is contained in:
Bowen Liang
@@ -21,162 +21,174 @@ class ToolProviderController(BaseModel, ABC):
|
||||
|
||||
def get_credentials_schema(self) -> dict[str, ToolProviderCredentials]:
|
||||
"""
|
||||
returns the credentials schema of the provider
|
||||
returns the credentials schema of the provider
|
||||
|
||||
:return: the credentials schema
|
||||
:return: the credentials schema
|
||||
"""
|
||||
return self.credentials_schema.copy()
|
||||
|
||||
|
||||
@abstractmethod
|
||||
def get_tools(self) -> list[Tool]:
|
||||
"""
|
||||
returns a list of tools that the provider can provide
|
||||
returns a list of tools that the provider can provide
|
||||
|
||||
:return: list of tools
|
||||
:return: list of tools
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def get_tool(self, tool_name: str) -> Tool:
|
||||
"""
|
||||
returns a tool that the provider can provide
|
||||
returns a tool that the provider can provide
|
||||
|
||||
:return: tool
|
||||
:return: tool
|
||||
"""
|
||||
pass
|
||||
|
||||
def get_parameters(self, tool_name: str) -> list[ToolParameter]:
|
||||
"""
|
||||
returns the parameters of the tool
|
||||
returns the parameters of the tool
|
||||
|
||||
:param tool_name: the name of the tool, defined in `get_tools`
|
||||
:return: list of parameters
|
||||
:param tool_name: the name of the tool, defined in `get_tools`
|
||||
:return: list of parameters
|
||||
"""
|
||||
tool = next(filter(lambda x: x.identity.name == tool_name, self.get_tools()), None)
|
||||
if tool is None:
|
||||
raise ToolNotFoundError(f'tool {tool_name} not found')
|
||||
raise ToolNotFoundError(f"tool {tool_name} not found")
|
||||
return tool.parameters
|
||||
|
||||
@property
|
||||
def provider_type(self) -> ToolProviderType:
|
||||
"""
|
||||
returns the type of the provider
|
||||
returns the type of the provider
|
||||
|
||||
:return: type of the provider
|
||||
:return: type of the provider
|
||||
"""
|
||||
return ToolProviderType.BUILT_IN
|
||||
|
||||
def validate_parameters(self, tool_id: int, tool_name: str, tool_parameters: dict[str, Any]) -> None:
|
||||
"""
|
||||
validate the parameters of the tool and set the default value if needed
|
||||
validate the parameters of the tool and set the default value if needed
|
||||
|
||||
:param tool_name: the name of the tool, defined in `get_tools`
|
||||
:param tool_parameters: the parameters of the tool
|
||||
:param tool_name: the name of the tool, defined in `get_tools`
|
||||
:param tool_parameters: the parameters of the tool
|
||||
"""
|
||||
tool_parameters_schema = self.get_parameters(tool_name)
|
||||
|
||||
|
||||
tool_parameters_need_to_validate: dict[str, ToolParameter] = {}
|
||||
for parameter in tool_parameters_schema:
|
||||
tool_parameters_need_to_validate[parameter.name] = parameter
|
||||
|
||||
for parameter in tool_parameters:
|
||||
if parameter not in tool_parameters_need_to_validate:
|
||||
raise ToolParameterValidationError(f'parameter {parameter} not found in tool {tool_name}')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} not found in tool {tool_name}")
|
||||
|
||||
# check type
|
||||
parameter_schema = tool_parameters_need_to_validate[parameter]
|
||||
if parameter_schema.type == ToolParameter.ToolParameterType.STRING:
|
||||
if not isinstance(tool_parameters[parameter], str):
|
||||
raise ToolParameterValidationError(f'parameter {parameter} should be string')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} should be string")
|
||||
|
||||
elif parameter_schema.type == ToolParameter.ToolParameterType.NUMBER:
|
||||
if not isinstance(tool_parameters[parameter], int | float):
|
||||
raise ToolParameterValidationError(f'parameter {parameter} should be number')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} should be number")
|
||||
|
||||
if parameter_schema.min is not None and tool_parameters[parameter] < parameter_schema.min:
|
||||
raise ToolParameterValidationError(f'parameter {parameter} should be greater than {parameter_schema.min}')
|
||||
|
||||
raise ToolParameterValidationError(
|
||||
f"parameter {parameter} should be greater than {parameter_schema.min}"
|
||||
)
|
||||
|
||||
if parameter_schema.max is not None and tool_parameters[parameter] > parameter_schema.max:
|
||||
raise ToolParameterValidationError(f'parameter {parameter} should be less than {parameter_schema.max}')
|
||||
|
||||
raise ToolParameterValidationError(
|
||||
f"parameter {parameter} should be less than {parameter_schema.max}"
|
||||
)
|
||||
|
||||
elif parameter_schema.type == ToolParameter.ToolParameterType.BOOLEAN:
|
||||
if not isinstance(tool_parameters[parameter], bool):
|
||||
raise ToolParameterValidationError(f'parameter {parameter} should be boolean')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} should be boolean")
|
||||
|
||||
elif parameter_schema.type == ToolParameter.ToolParameterType.SELECT:
|
||||
if not isinstance(tool_parameters[parameter], str):
|
||||
raise ToolParameterValidationError(f'parameter {parameter} should be string')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} should be string")
|
||||
|
||||
options = parameter_schema.options
|
||||
if not isinstance(options, list):
|
||||
raise ToolParameterValidationError(f'parameter {parameter} options should be list')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} options should be list")
|
||||
|
||||
if tool_parameters[parameter] not in [x.value for x in options]:
|
||||
raise ToolParameterValidationError(f'parameter {parameter} should be one of {options}')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} should be one of {options}")
|
||||
|
||||
tool_parameters_need_to_validate.pop(parameter)
|
||||
|
||||
for parameter in tool_parameters_need_to_validate:
|
||||
parameter_schema = tool_parameters_need_to_validate[parameter]
|
||||
if parameter_schema.required:
|
||||
raise ToolParameterValidationError(f'parameter {parameter} is required')
|
||||
|
||||
raise ToolParameterValidationError(f"parameter {parameter} is required")
|
||||
|
||||
# the parameter is not set currently, set the default value if needed
|
||||
if parameter_schema.default is not None:
|
||||
tool_parameters[parameter] = ToolParameterConverter.cast_parameter_by_type(parameter_schema.default,
|
||||
parameter_schema.type)
|
||||
tool_parameters[parameter] = ToolParameterConverter.cast_parameter_by_type(
|
||||
parameter_schema.default, parameter_schema.type
|
||||
)
|
||||
|
||||
def validate_credentials_format(self, credentials: dict[str, Any]) -> None:
|
||||
"""
|
||||
validate the format of the credentials of the provider and set the default value if needed
|
||||
validate the format of the credentials of the provider and set the default value if needed
|
||||
|
||||
:param credentials: the credentials of the tool
|
||||
:param credentials: the credentials of the tool
|
||||
"""
|
||||
credentials_schema = self.credentials_schema
|
||||
if credentials_schema is None:
|
||||
return
|
||||
|
||||
|
||||
credentials_need_to_validate: dict[str, ToolProviderCredentials] = {}
|
||||
for credential_name in credentials_schema:
|
||||
credentials_need_to_validate[credential_name] = credentials_schema[credential_name]
|
||||
|
||||
for credential_name in credentials:
|
||||
if credential_name not in credentials_need_to_validate:
|
||||
raise ToolProviderCredentialValidationError(f'credential {credential_name} not found in provider {self.identity.name}')
|
||||
|
||||
raise ToolProviderCredentialValidationError(
|
||||
f"credential {credential_name} not found in provider {self.identity.name}"
|
||||
)
|
||||
|
||||
# check type
|
||||
credential_schema = credentials_need_to_validate[credential_name]
|
||||
if credential_schema == ToolProviderCredentials.CredentialsType.SECRET_INPUT or \
|
||||
credential_schema == ToolProviderCredentials.CredentialsType.TEXT_INPUT:
|
||||
if (
|
||||
credential_schema == ToolProviderCredentials.CredentialsType.SECRET_INPUT
|
||||
or credential_schema == ToolProviderCredentials.CredentialsType.TEXT_INPUT
|
||||
):
|
||||
if not isinstance(credentials[credential_name], str):
|
||||
raise ToolProviderCredentialValidationError(f'credential {credential_name} should be string')
|
||||
|
||||
raise ToolProviderCredentialValidationError(f"credential {credential_name} should be string")
|
||||
|
||||
elif credential_schema.type == ToolProviderCredentials.CredentialsType.SELECT:
|
||||
if not isinstance(credentials[credential_name], str):
|
||||
raise ToolProviderCredentialValidationError(f'credential {credential_name} should be string')
|
||||
|
||||
raise ToolProviderCredentialValidationError(f"credential {credential_name} should be string")
|
||||
|
||||
options = credential_schema.options
|
||||
if not isinstance(options, list):
|
||||
raise ToolProviderCredentialValidationError(f'credential {credential_name} options should be list')
|
||||
|
||||
raise ToolProviderCredentialValidationError(f"credential {credential_name} options should be list")
|
||||
|
||||
if credentials[credential_name] not in [x.value for x in options]:
|
||||
raise ToolProviderCredentialValidationError(f'credential {credential_name} should be one of {options}')
|
||||
|
||||
raise ToolProviderCredentialValidationError(
|
||||
f"credential {credential_name} should be one of {options}"
|
||||
)
|
||||
|
||||
credentials_need_to_validate.pop(credential_name)
|
||||
|
||||
for credential_name in credentials_need_to_validate:
|
||||
credential_schema = credentials_need_to_validate[credential_name]
|
||||
if credential_schema.required:
|
||||
raise ToolProviderCredentialValidationError(f'credential {credential_name} is required')
|
||||
|
||||
raise ToolProviderCredentialValidationError(f"credential {credential_name} is required")
|
||||
|
||||
# the credential is not set currently, set the default value if needed
|
||||
if credential_schema.default is not None:
|
||||
default_value = credential_schema.default
|
||||
# parse default value into the correct type
|
||||
if credential_schema.type == ToolProviderCredentials.CredentialsType.SECRET_INPUT or \
|
||||
credential_schema.type == ToolProviderCredentials.CredentialsType.TEXT_INPUT or \
|
||||
credential_schema.type == ToolProviderCredentials.CredentialsType.SELECT:
|
||||
if (
|
||||
credential_schema.type == ToolProviderCredentials.CredentialsType.SECRET_INPUT
|
||||
or credential_schema.type == ToolProviderCredentials.CredentialsType.TEXT_INPUT
|
||||
or credential_schema.type == ToolProviderCredentials.CredentialsType.SELECT
|
||||
):
|
||||
default_value = str(default_value)
|
||||
|
||||
credentials[credential_name] = default_value
|
||||
|
||||
Reference in New Issue
Block a user