Model Runtime (#1858)

Co-authored-by: StyleZhang <jasonapring2015@outlook.com>
Co-authored-by: Garfield Dai <dai.hai@foxmail.com>
Co-authored-by: chenhe <guchenhe@gmail.com>
Co-authored-by: jyong <jyong@dify.ai>
Co-authored-by: Joel <iamjoel007@gmail.com>
Co-authored-by: Yeuoly <admin@srmxy.cn>

api/core/moderation/cloud_service/cloud_service.py

@@ -0,0 +1,93 @@
+from core.moderation.base import Moderation, ModerationAction, ModerationInputsResult, ModerationOutputsResult
+
+
+class CloudServiceModeration(Moderation):
+    """
+    The name of custom type must be unique, keep the same with directory and file name.
+    """
+    name: str = "cloud_service"
+
+    @classmethod
+    def validate_config(cls, tenant_id: str, config: dict) -> None:
+        """
+        schema.json validation. It will be called when user save the config.
+
+        Example:
+            .. code-block:: python
+                config = {
+                    "cloud_provider": "GoogleCloud",
+                    "api_endpoint": "https://api.example.com",
+                    "api_keys": "123456",
+                    "inputs_config": {
+                        "enabled": True,
+                        "preset_response": "Your content violates our usage policy. Please revise and try again."
+                    },
+                    "outputs_config": {
+                        "enabled": True,
+                        "preset_response": "Your content violates our usage policy. Please revise and try again."
+                    }
+                }
+
+        :param tenant_id: the id of workspace
+        :param config: the variables of form config
+        :return:
+        """
+
+        cls._validate_inputs_and_outputs_config(config, True)
+
+        if not config.get("cloud_provider"):
+            raise ValueError("cloud_provider is required")
+
+        if not config.get("api_endpoint"):
+            raise ValueError("api_endpoint is required")
+
+        if not config.get("api_keys"):
+            raise ValueError("api_keys is required")
+
+    def moderation_for_inputs(self, inputs: dict, query: str = "") -> ModerationInputsResult:
+        """
+        Moderation for inputs.
+
+        :param inputs: user inputs
+        :param query: the query of chat app, there is empty if is completion app
+        :return: the moderation result
+        """
+        flagged = False
+        preset_response = ""
+
+        if self.config['inputs_config']['enabled']:
+            preset_response = self.config['inputs_config']['preset_response']
+
+            if query:
+                inputs['query__'] = query
+            flagged = self._is_violated(inputs)
+
+        # return ModerationInputsResult(flagged=flagged, action=ModerationAction.OVERRIDED, inputs=inputs, query=query)
+        return ModerationInputsResult(flagged=flagged, action=ModerationAction.DIRECT_OUTPUT, preset_response=preset_response)
+
+    def moderation_for_outputs(self, text: str) -> ModerationOutputsResult:
+        """
+        Moderation for outputs.
+
+        :param text: the text of LLM response
+        :return: the moderation result
+        """
+        flagged = False
+        preset_response = ""
+
+        if self.config['outputs_config']['enabled']:
+            preset_response = self.config['outputs_config']['preset_response']
+
+            flagged = self._is_violated({'text': text})
+
+        # return ModerationOutputsResult(flagged=flagged, action=ModerationAction.OVERRIDED, text=text)
+        return ModerationOutputsResult(flagged=flagged, action=ModerationAction.DIRECT_OUTPUT, preset_response=preset_response)
+
+    def _is_violated(self, inputs: dict):
+        """
+        The main logic of moderation.
+
+        :param inputs:
+        :return: the moderation result
+        """
+        return False

api/core/moderation/cloud_service/schema.json

@@ -0,0 +1,65 @@
+{
+    "label": {
+        "en-US": "Cloud Service",
+        "zh-Hans": "云服务"
+    },
+    "form_schema": [
+        {
+            "type": "select",
+            "label": {
+                "en-US": "Cloud Provider",
+                "zh-Hans": "云厂商"
+            },
+            "variable": "cloud_provider",
+            "required": true,
+            "options": [
+                {
+                    "label": {
+                        "en-US": "AWS",
+                        "zh-Hans": "亚马逊"
+                    },
+                    "value": "AWS"
+                },
+                {
+                    "label": {
+                        "en-US": "Google Cloud",
+                        "zh-Hans": "谷歌云"
+                    },
+                    "value": "GoogleCloud"
+                },
+                {
+                    "label": {
+                        "en-US": "Azure Cloud",
+                        "zh-Hans": "微软云"
+                    },
+                    "value": "Azure"
+                }
+            ],
+            "default": "GoogleCloud",
+            "placeholder": ""
+        },
+        {
+            "type": "text-input",
+            "label": {
+                "en-US": "API Endpoint",
+                "zh-Hans": "API Endpoint"
+            },
+            "variable": "api_endpoint",
+            "required": true,
+            "max_length": 100,
+            "default": "",
+            "placeholder": "https://api.example.com"
+        },
+        {
+            "type": "paragraph",
+            "label": {
+                "en-US": "API Key",
+                "zh-Hans": "API Key"
+            },
+            "variable": "api_keys",
+            "required": true,
+            "default": "",
+            "placeholder": "Paste your API key here"
+        }
+    ]
+}

api/core/moderation/openai_moderation/openai_moderation.py

@@ -1,5 +1,6 @@
+from core.model_manager import ModelManager
+from core.model_runtime.entities.model_entities import ModelType
 from core.moderation.base import Moderation, ModerationInputsResult, ModerationOutputsResult, ModerationAction
-from core.model_providers.model_factory import ModelFactory
 
 
 class OpenAIModeration(Moderation):
@@ -41,6 +42,16 @@ class OpenAIModeration(Moderation):
 
     def _is_violated(self, inputs: dict):
         text = '\n'.join(inputs.values())
-        openai_moderation = ModelFactory.get_moderation_model(self.tenant_id, "openai", "moderation")
-        is_not_invalid = openai_moderation.run(text)
-        return not is_not_invalid
+        model_manager = ModelManager()
+        model_instance = model_manager.get_model_instance(
+            tenant_id=self.tenant_id,
+            provider="openai",
+            model_type=ModelType.MODERATION,
+            model="text-moderation-stable"
+        )
+
+        openai_moderation = model_instance.invoke_moderation(
+            text=text
+        )
+
+        return openai_moderation