ngskcloud
/
gcgj-dify-1.7.0
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: support plugin inner api

Browse Source
pull/9184/head
Yeuoly 2 years ago
parent ed7fcc5f7d
commit f29b44acd8
No known key found for this signature in database
GPG Key ID: A66E7E320FB19F61
5 changed files with 210 additions and 118 deletions
Show Stats Download Patch File Download Diff File

69
api/controllers/inner_api/plugin/plugin.py
Unescape Escape View File

@ -1,34 +1,68 @@
from flask_restful import Resource, reqparse from flask_restful import Resource, reqparse
from controllers.console.setup import setup_required from controllers.console.setup import setup_required
from controllers.inner_api import api from controllers.inner_api import api
from controllers.inner_api.plugin.wraps import get_tenant from controllers.inner_api.plugin.wraps import get_tenant, plugin_data
from controllers.inner_api.wraps import plugin_inner_api_only from controllers.inner_api.wraps import plugin_inner_api_only
from core.plugin.entities.request import RequestInvokeLLM, RequestInvokeModeration, RequestInvokeRerank, RequestInvokeSpeech2Text, RequestInvokeTTS, RequestInvokeTextEmbedding, RequestInvokeTool
from libs.helper import compact_generate_response from libs.helper import compact_generate_response
from models.account import Tenant from models.account import Tenant
from services.plugin.plugin_invoke_service import PluginInvokeService from services.plugin.plugin_invoke_service import PluginInvokeService
class PluginInvokeModelApi(Resource): class PluginInvokeLLMApi(Resource):
@setup_required @setup_required
@plugin_inner_api_only @plugin_inner_api_only
@get_tenant @get_tenant
def post(self, user_id: str, tenant_model: Tenant): @plugin_data(payload_type=RequestInvokeLLM)
parser = reqparse.RequestParser() def post(self, user_id: str, tenant_model: Tenant, payload: RequestInvokeLLM):
parser.add_argument('provider', type=dict, required=True, location='json') pass
parser.add_argument('model', type=dict, required=True, location='json')
parser.add_argument('parameters', type=dict, required=True, location='json')
args = parser.parse_args() class PluginInvokeTextEmbeddingApi(Resource):
@setup_required
@plugin_inner_api_only
@get_tenant
@plugin_data(payload_type=RequestInvokeTextEmbedding)
def post(self, user_id: str, tenant_model: Tenant, payload: RequestInvokeTextEmbedding):
pass
class PluginInvokeRerankApi(Resource):
@setup_required
@plugin_inner_api_only
@get_tenant
@plugin_data(payload_type=RequestInvokeRerank)
def post(self, user_id: str, tenant_model: Tenant, payload: RequestInvokeRerank):
pass
class PluginInvokeTTSApi(Resource):
@setup_required
@plugin_inner_api_only
@get_tenant
@plugin_data(payload_type=RequestInvokeTTS)
def post(self, user_id: str, tenant_model: Tenant, payload: RequestInvokeTTS):
pass
class PluginInvokeSpeech2TextApi(Resource):
@setup_required
@plugin_inner_api_only
@get_tenant
@plugin_data(payload_type=RequestInvokeSpeech2Text)
def post(self, user_id: str, tenant_model: Tenant, payload: RequestInvokeSpeech2Text):
pass
class PluginInvokeModerationApi(Resource):
@setup_required
@plugin_inner_api_only
@get_tenant
@plugin_data(payload_type=RequestInvokeModeration)
def post(self, user_id: str, tenant_model: Tenant, payload: RequestInvokeModeration):
pass
class PluginInvokeToolApi(Resource): class PluginInvokeToolApi(Resource):
@setup_required @setup_required
@plugin_inner_api_only @plugin_inner_api_only
@get_tenant @get_tenant
@plugin_data(payload_type=RequestInvokeTool)
def post(self, user_id: str, tenant_model: Tenant): def post(self, user_id: str, tenant_model: Tenant):
parser = reqparse.RequestParser() parser = reqparse.RequestParser()
parser.add_argument('provider', type=dict, required=True, location='json') parser.add_argument('provider', type=dict, required=True, location='json')
@ -37,9 +71,9 @@ class PluginInvokeToolApi(Resource):
args = parser.parse_args() args = parser.parse_args()
response = PluginInvokeService.invoke_tool(user_id, tenant_model, response = PluginInvokeService.invoke_tool(
args['provider'], args['tool'], user_id, tenant_model, args['provider'], args['tool'], args['parameters']
args['parameters']) )
return compact_generate_response(response) return compact_generate_response(response)
@ -51,11 +85,14 @@ class PluginInvokeNodeApi(Resource):
parser = reqparse.RequestParser() parser = reqparse.RequestParser()
args = parser.parse_args() args = parser.parse_args()
return { return {'message': 'success'}
'message': 'success'
}
api.add_resource(PluginInvokeModelApi, '/invoke/model') api.add_resource(PluginInvokeLLMApi, '/invoke/llm')
api.add_resource(PluginInvokeTextEmbeddingApi, '/invoke/text-embedding')
api.add_resource(PluginInvokeRerankApi, '/invoke/rerank')
api.add_resource(PluginInvokeTTSApi, '/invoke/tts')
api.add_resource(PluginInvokeSpeech2TextApi, '/invoke/speech2text')
api.add_resource(PluginInvokeModerationApi, '/invoke/moderation')
api.add_resource(PluginInvokeToolApi, '/invoke/tool') api.add_resource(PluginInvokeToolApi, '/invoke/tool')
api.add_resource(PluginInvokeNodeApi, '/invoke/node') api.add_resource(PluginInvokeNodeApi, '/invoke/node')

25
api/controllers/inner_api/plugin/wraps.py
Unescape Escape View File

@ -2,7 +2,9 @@ from collections.abc import Callable
from functools import wraps from functools import wraps
from typing import Optional from typing import Optional
from flask import request
from flask_restful import reqparse from flask_restful import reqparse
from pydantic import BaseModel
from extensions.ext_database import db from extensions.ext_database import db
from models.account import Tenant from models.account import Tenant
@ -45,3 +47,26 @@ def get_tenant(view: Optional[Callable] = None):
return decorator return decorator
else: else:
return decorator(view) return decorator(view)
def plugin_data(view: Optional[Callable] = None, *, payload_type: type[BaseModel]):
def decorator(view_func):
def decorated_view(*args, **kwargs):
try:
data = request.get_json()
except Exception:
raise ValueError('invalid json')
try:
payload = payload_type(**data)
except Exception as e:
raise ValueError(f'invalid payload: {str(e)}')
kwargs['payload'] = payload
return view_func(*args, **kwargs)
return decorated_view
if view is None:
return decorator
else:
return decorator(view)

42
api/core/plugin/entities/request.py
Unescape Escape 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
Unescape Escape View File

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

127
api/core/tools/tool/tool.py
Unescape Escape View File

@ -40,8 +40,9 @@ class Tool(BaseModel, ABC):
class Runtime(BaseModel): class Runtime(BaseModel):
""" """
Meta data of a tool call processing Meta data of a tool call processing
""" """
def __init__(self, **data: Any): def __init__(self, **data: Any):
super().__init__(**data) super().__init__(**data)
if not self.runtime_parameters: if not self.runtime_parameters:
@ -65,10 +66,10 @@ class Tool(BaseModel, ABC):
def fork_tool_runtime(self, runtime: dict[str, Any]) -> 'Tool': 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 :param meta: the meta data of a tool call processing, tenant_id is required
:return: the new tool :return: the new tool
""" """
return self.__class__( return self.__class__(
identity=self.identity.model_copy() if self.identity else None, identity=self.identity.model_copy() if self.identity else None,
@ -80,22 +81,22 @@ class Tool(BaseModel, ABC):
@abstractmethod @abstractmethod
def tool_provider_type(self) -> ToolProviderType: 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): 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 self.variables = variables
def set_image_variable(self, variable_name: str, image_key: str) -> None: def set_image_variable(self, variable_name: str, image_key: str) -> None:
""" """
set an image variable set an image variable
""" """
if not self.variables: if not self.variables:
return return
@ -104,7 +105,7 @@ class Tool(BaseModel, ABC):
def set_text_variable(self, variable_name: str, text: str) -> None: def set_text_variable(self, variable_name: str, text: str) -> None:
""" """
set a text variable set a text variable
""" """
if not self.variables: if not self.variables:
return return
@ -113,10 +114,10 @@ class Tool(BaseModel, ABC):
def get_variable(self, name: Union[str, Enum]) -> Optional[ToolRuntimeVariable]: def get_variable(self, name: Union[str, Enum]) -> Optional[ToolRuntimeVariable]:
""" """
get a variable get a variable
:param name: the name of the variable :param name: the name of the variable
:return: the variable :return: the variable
""" """
if not self.variables: if not self.variables:
return None return None
@ -132,9 +133,9 @@ class Tool(BaseModel, ABC):
def get_default_image_variable(self) -> Optional[ToolRuntimeVariable]: 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: if not self.variables:
return None return None
@ -143,10 +144,10 @@ class Tool(BaseModel, ABC):
def get_variable_file(self, name: Union[str, Enum]) -> Optional[bytes]: 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 :param name: the name of the variable
:return: the variable file :return: the variable file
""" """
variable = self.get_variable(name) variable = self.get_variable(name)
if not variable: if not variable:
@ -165,9 +166,9 @@ class Tool(BaseModel, ABC):
def list_variables(self) -> list[ToolRuntimeVariable]: def list_variables(self) -> list[ToolRuntimeVariable]:
""" """
list all variables list all variables
:return: the variables :return: the variables
""" """
if not self.variables: if not self.variables:
return [] return []
@ -176,9 +177,9 @@ class Tool(BaseModel, ABC):
def list_default_image_variables(self) -> list[ToolRuntimeVariable]: 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: if not self.variables:
return [] return []
@ -215,7 +216,9 @@ class Tool(BaseModel, ABC):
result = deepcopy(tool_parameters) result = deepcopy(tool_parameters)
for parameter in self.parameters or []: for parameter in self.parameters or []:
if parameter.name in tool_parameters: 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 return result
@ -225,28 +228,28 @@ class Tool(BaseModel, ABC):
def validate_credentials(self, credentials: dict[str, Any], parameters: dict[str, Any]) -> None: def validate_credentials(self, credentials: dict[str, Any], parameters: dict[str, Any]) -> None:
""" """
validate the credentials validate the credentials
:param credentials: the credentials :param credentials: the credentials
:param parameters: the parameters :param parameters: the parameters
""" """
pass pass
def get_runtime_parameters(self) -> list[ToolParameter]: 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 [] return self.parameters or []
def get_all_runtime_parameters(self) -> list[ToolParameter]: 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 = self.parameters or []
parameters = parameters.copy() parameters = parameters.copy()
@ -278,65 +281,47 @@ class Tool(BaseModel, ABC):
def create_image_message(self, image: str, save_as: str = '') -> ToolInvokeMessage: 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 :param image: the url of the image
:return: the image message :return: the image message
""" """
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.IMAGE, return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.IMAGE, message=image, save_as=save_as)
message=image,
save_as=save_as)
def create_file_var_message(self, file_var: FileVar) -> ToolInvokeMessage: def create_file_var_message(self, file_var: FileVar) -> ToolInvokeMessage:
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.FILE_VAR, return ToolInvokeMessage(
message='', type=ToolInvokeMessage.MessageType.FILE_VAR, message='', meta={'file_var': file_var}, save_as=''
meta={ )
'file_var': file_var
},
save_as='')
def create_link_message(self, link: str, save_as: str = '') -> ToolInvokeMessage: 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 :param link: the url of the link
:return: the link message :return: the link message
""" """
return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.LINK, return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.LINK, message=link, save_as=save_as)
message=link,
save_as=save_as)
def create_text_message(self, text: str, save_as: str = '') -> ToolInvokeMessage: def create_text_message(self, text: str, save_as: str = '') -> ToolInvokeMessage:
""" """
create a text message create a text message
:param text: the text :param text: the text
:return: the text message :return: the text message
""" """
return ToolInvokeMessage( return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.TEXT, message=text, save_as=save_as)
type=ToolInvokeMessage.MessageType.TEXT,
message=text,
save_as=save_as
)
def create_blob_message(self, blob: bytes, meta: dict = None, save_as: str = '') -> ToolInvokeMessage: def create_blob_message(self, blob: bytes, meta: Optional[dict] = None, save_as: str = '') -> ToolInvokeMessage:
""" """
create a blob message create a blob message
:param blob: the blob :param blob: the blob
:return: the blob message :return: the blob message
""" """
return ToolInvokeMessage( return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.BLOB, message=blob, meta=meta, save_as=save_as)
type=ToolInvokeMessage.MessageType.BLOB,
message=blob, meta=meta,
save_as=save_as
)
def create_json_message(self, object: dict) -> ToolInvokeMessage: def create_json_message(self, object: dict) -> ToolInvokeMessage:
""" """
create a json message create a json message
""" """
return ToolInvokeMessage( return ToolInvokeMessage(type=ToolInvokeMessage.MessageType.JSON, message=object)
type=ToolInvokeMessage.MessageType.JSON,
message=object
)

Write Preview
Loading…
Cancel
Save