youngkingdom/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-05-02 00:18:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: support plugin inner api

Browse Source
This commit is contained in:
Yeuoly
2024-07-29 16:40:04 +08:00
parent ed7fcc5f7d
commit f29b44acd8
5 changed files with 211 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
api/core/plugin/entities/request.py Normal file
View File

@ -0,0 +1,42 @@
from pydantic import BaseModel
class RequestInvokeTool(BaseModel):
"""
Request to invoke a tool
"""
class RequestInvokeLLM(BaseModel):
"""
Request to invoke LLM
"""
class RequestInvokeTextEmbedding(BaseModel):
"""
Request to invoke text embedding
"""
class RequestInvokeRerank(BaseModel):
"""
Request to invoke rerank
"""
class RequestInvokeTTS(BaseModel):
"""
Request to invoke TTS
"""
class RequestInvokeSpeech2Text(BaseModel):
"""
Request to invoke speech2text
"""
class RequestInvokeModeration(BaseModel):
"""
Request to invoke moderation
"""
class RequestInvokeNode(BaseModel):
"""
Request to invoke node
"""

13
api/core/tools/entities/tool_entities.py
View File

@ -103,8 +103,8 @@ class ToolInvokeMessage(BaseModel):
"""
plain text, image url or link url
"""
message: Union[str, bytes, dict] = None
meta: dict[str, Any] = None
message: Optional[Union[str, bytes, dict]] = None
meta: Optional[dict[str, Any]] = None
save_as: str = ''
class ToolInvokeMessageBinary(BaseModel):
@ -168,16 +168,19 @@ class ToolParameter(BaseModel):
"""
# convert options to ToolParameterOption
if options:
options = [ToolParameterOption(value=option, label=I18nObject(en_US=option, zh_Hans=option)) for option in options]
option_objs = [ToolParameterOption(value=option, label=I18nObject(en_US=option, zh_Hans=option)) for option in options]
else:
option_objs = None
return cls(
name=name,
label=I18nObject(en_US='', zh_Hans=''),
placeholder=None,
human_description=I18nObject(en_US='', zh_Hans=''),
type=type,
form=cls.ToolParameterForm.LLM,
llm_description=llm_description,
required=required,
options=options,
options=option_objs,
)
class ToolProviderIdentity(BaseModel):
@ -245,7 +248,7 @@ class ToolProviderCredentials(BaseModel):
'default': self.default,
'options': self.options,
'help': self.help.to_dict() if self.help else None,
'label': self.label.to_dict(),
'label': self.label.to_dict() if self.label else None,
'url': self.url,
'placeholder': self.placeholder.to_dict() if self.placeholder else None,
}

177
api/core/tools/tool/tool.py
View File

@ -40,8 +40,9 @@ class Tool(BaseModel, ABC):
class Runtime(BaseModel):
"""
Meta data of a tool call processing
Meta data of a tool call processing
"""
def __init__(self, **data: Any):
super().__init__(**data)
if not self.runtime_parameters:
@ -65,10 +66,10 @@ class Tool(BaseModel, ABC):
def fork_tool_runtime(self, runtime: dict[str, Any]) -> 'Tool':
"""
fork a new tool with meta data
fork a new tool with meta data
:param meta: the meta data of a tool call processing, tenant_id is required
:return: the new tool
:param meta: the meta data of a tool call processing, tenant_id is required
:return: the new tool
"""
return self.__class__(
identity=self.identity.model_copy() if self.identity else None,
@ -76,82 +77,82 @@ class Tool(BaseModel, ABC):
description=self.description.model_copy() if self.description else None,
runtime=Tool.Runtime(**runtime),
)
@abstractmethod
def tool_provider_type(self) -> ToolProviderType:
"""
get the tool provider type
get the tool provider type
:return: the tool provider type
:return: the tool provider type
"""
def load_variables(self, variables: ToolRuntimeVariablePool):
"""
load variables from database
load variables from database
:param conversation_id: the conversation id
:param conversation_id: the conversation id
"""
self.variables = variables
def set_image_variable(self, variable_name: str, image_key: str) -> None:
"""
set an image variable
set an image variable
"""
if not self.variables:
return
self.variables.set_file(self.identity.name, variable_name, image_key)
def set_text_variable(self, variable_name: str, text: str) -> None:
"""
set a text variable
set a text variable
"""
if not self.variables:
return
self.variables.set_text(self.identity.name, variable_name, text)
def get_variable(self, name: Union[str, Enum]) -> Optional[ToolRuntimeVariable]:
"""
get a variable
get a variable
:param name: the name of the variable
:return: the variable
:param name: the name of the variable
:return: the variable
"""
if not self.variables:
return None
if isinstance(name, Enum):
name = name.value
for variable in self.variables.pool:
if variable.name == name:
return variable
return None
def get_default_image_variable(self) -> Optional[ToolRuntimeVariable]:
"""
get the default image variable
get the default image variable
:return: the image variable
:return: the image variable
"""
if not self.variables:
return None
return self.get_variable(self.VARIABLE_KEY.IMAGE)
def get_variable_file(self, name: Union[str, Enum]) -> Optional[bytes]:
"""
get a variable file
get a variable file
:param name: the name of the variable
:return: the variable file
:param name: the name of the variable
:return: the variable file
"""
variable = self.get_variable(name)
if not variable:
return None
if not isinstance(variable, ToolRuntimeImageVariable):
return None
@ -160,31 +161,31 @@ class Tool(BaseModel, ABC):
file_binary = ToolFileManager.get_file_binary_by_message_file_id(message_file_id)
if not file_binary:
return None
return file_binary[0]
def list_variables(self) -> list[ToolRuntimeVariable]:
"""
list all variables
list all variables
:return: the variables
:return: the variables
"""
if not self.variables:
return []
return self.variables.pool
def list_default_image_variables(self) -> list[ToolRuntimeVariable]:
"""
list all image variables
list all image variables
:return: the image variables
:return: the image variables
"""
if not self.variables:
return []
result = []
for variable in self.variables.pool:
if variable.name.startswith(self.VARIABLE_KEY.IMAGE.value):
result.append(variable)
@ -215,38 +216,40 @@ class Tool(BaseModel, ABC):
result = deepcopy(tool_parameters)
for parameter in self.parameters or []:
if parameter.name in tool_parameters:
result[parameter.name] = ToolParameterConverter.cast_parameter_by_type(tool_parameters[parameter.name], parameter.type)
result[parameter.name] = ToolParameterConverter.cast_parameter_by_type(
tool_parameters[parameter.name], parameter.type
)
return result
@abstractmethod
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]) -> Generator[ToolInvokeMessage, None, None]:
pass
def validate_credentials(self, credentials: dict[str, Any], parameters: dict[str, Any]) -> None:
"""
validate the credentials
validate the credentials
:param credentials: the credentials
:param parameters: the parameters
:param credentials: the credentials
:param parameters: the parameters
"""
pass
def get_runtime_parameters(self) -> list[ToolParameter]:
"""
get the runtime parameters
get the runtime parameters
interface for developer to dynamic change the parameters of a tool depends on the variables pool
interface for developer to dynamic change the parameters of a tool depends on the variables pool
:return: the runtime parameters
:return: the runtime parameters
"""
return self.parameters or []
def get_all_runtime_parameters(self) -> list[ToolParameter]:
"""
get all runtime parameters
get all runtime parameters
:return: all runtime parameters
:return: all runtime parameters
"""
parameters = self.parameters or []
parameters = parameters.copy()
@ -275,68 +278,50 @@ class Tool(BaseModel, ABC):
parameters.append(parameter)
return parameters
def create_image_message(self, image: str, save_as: str = '') -> ToolInvokeMessage:
"""
create an image message
create an image message
:param image: the url of the image
:return: the image message
:param image: the url of the image
:return: the image message
"""
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.IMAGE,
message=image,
save_as=save_as)
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.IMAGE, message=image, save_as=save_as)
def create_file_var_message(self, file_var: FileVar) -> ToolInvokeMessage:
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.FILE_VAR,
message='',
meta={
'file_var': file_var
},
save_as='')
return ToolInvokeMessage(
type=ToolInvokeMessage.MessageType.FILE_VAR, message='', meta={'file_var': file_var}, save_as=''
)
def create_link_message(self, link: str, save_as: str = '') -> ToolInvokeMessage:
"""
create a link message
create a link message
:param link: the url of the link
:return: the link message
:param link: the url of the link
:return: the link message
"""
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.LINK,
message=link,
save_as=save_as)
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.LINK, message=link, save_as=save_as)
def create_text_message(self, text: str, save_as: str = '') -> ToolInvokeMessage:
"""
create a text message
create a text message
:param text: the text
:return: the text message
:param text: the text
:return: the text message
"""
return ToolInvokeMessage(
type=ToolInvokeMessage.MessageType.TEXT,
message=text,
save_as=save_as
)
def create_blob_message(self, blob: bytes, meta: dict = None, save_as: str = '') -> ToolInvokeMessage:
"""
create a blob message
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.TEXT, message=text, save_as=save_as)
:param blob: the blob
:return: the blob message
def create_blob_message(self, blob: bytes, meta: Optional[dict] = None, save_as: str = '') -> ToolInvokeMessage:
"""
return ToolInvokeMessage(
type=ToolInvokeMessage.MessageType.BLOB,
message=blob, meta=meta,
save_as=save_as
)
create a blob message
:param blob: the blob
:return: the blob message
"""
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.BLOB, message=blob, meta=meta, save_as=save_as)
def create_json_message(self, object: dict) -> ToolInvokeMessage:
"""
create a json message
create a json message
"""
return ToolInvokeMessage(
type=ToolInvokeMessage.MessageType.JSON,
message=object
)
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.JSON, message=object)