dify_plugin 0.1.0__tar.gz → 0.2.0__tar.gz

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/LICENSE

@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dify_plugin
-Version: 0.1.0
+Version: 0.2.0
 Summary: Dify Plugin SDK
 Keywords: dify,plugin,sdk
 Author-Email: langgenius <hello@dify.ai>
@@ -43,6 +43,6 @@ When depending on this SDK, it's recommended to specify version constraints that
 Example in your project's dependency management:
 
 ```
-dify_plugin = ">=0.1.0,<0.2.0"
+dify_plugin>=0.1.0,<0.2.0
 ```
 

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/README.md

@@ -19,6 +19,6 @@ When depending on this SDK, it's recommended to specify version constraints that
 Example in your project's dependency management:
 
 ```
-dify_plugin = ">=0.1.0,<0.2.0"
+dify_plugin>=0.1.0,<0.2.0
 ```
 

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/entities/invocation.py

@@ -15,6 +15,7 @@ class InvokeType(Enum):
     Storage = "storage"
     UploadFile = "upload_file"
     SYSTEM_SUMMARY = "system_summary"
+    FetchApp = "fetch_app"
 
     @classmethod
     def value_of(cls, value: str) -> "InvokeType":

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/entities/plugin/setup.py

@@ -75,6 +75,7 @@ class PluginConfiguration(BaseModel):
         version: str
         arch: list[PluginArch]
         runner: PluginRunner
+        minimum_dify_version: Optional[str] = Field(..., pattern=r"^\d{1,4}(\.\d{1,4}){1,3}(-\w{1,16})?$")
 
     version: str = Field(..., pattern=r"^\d{1,4}(\.\d{1,4}){1,3}(-\w{1,16})?$")
     type: PluginType

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/plugin_executor.py

@@ -281,7 +281,7 @@ class PluginExecutor:
         except ValueError as e:
             response = Response(str(e), status=404)
         except Exception as e:
-            response = Response(f"Internal Server Error: {str(e)}", status=500)
+            response = Response(f"Internal Server Error: {e!s}", status=500)
 
         # check if response is a generator
         if isinstance(response.response, Generator):

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/plugin_registration.py

@@ -123,7 +123,7 @@ class PluginRegistration:
                 self.agent_strategies_configuration.append(agent_provider_configuration)
 
         except Exception as e:
-            raise ValueError(f"Error loading plugin configuration: {str(e)}") from e
+            raise ValueError(f"Error loading plugin configuration: {e!s}") from e
 
     def _resolve_tool_providers(self):
         """
@@ -349,4 +349,4 @@ class PluginRegistration:
             endpoint, values = adapter.match()
             return endpoint, values
         except werkzeug.exceptions.HTTPException as e:
-            raise ValueError(f"Failed to dispatch endpoint request: {str(e)}") from e
+            raise ValueError(f"Failed to dispatch endpoint request: {e!s}") from e

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/runtime.py

@@ -1,13 +1,12 @@
-import json
 import uuid
 from abc import ABC
-from collections.abc import Generator
+from collections.abc import Generator, Mapping
 from concurrent.futures import ThreadPoolExecutor
 from enum import Enum
-from typing import Generic, Optional, TypeVar, Union
+from typing import Any, Generic, Optional, TypeVar, Union
 
 import httpx
-from pydantic import BaseModel
+from pydantic import BaseModel, TypeAdapter
 from yarl import URL
 
 from dify_plugin.config.config import InstallMethod
@@ -46,6 +45,7 @@ class ModelInvocations:
 
 class AppInvocations:
     def __init__(self, session: "Session"):
+        from dify_plugin.invocations.app import FetchAppInvocation
         from dify_plugin.invocations.app.chat import ChatAppInvocation
         from dify_plugin.invocations.app.completion import CompletionAppInvocation
         from dify_plugin.invocations.app.workflow import WorkflowAppInvocation
@@ -53,6 +53,10 @@ class AppInvocations:
         self.chat = ChatAppInvocation(session)
         self.completion = CompletionAppInvocation(session)
         self.workflow = WorkflowAppInvocation(session)
+        self.fetch_app_invocation = FetchAppInvocation(session)
+
+    def fetch_app(self, app_id: str) -> Mapping:
+        return self.fetch_app_invocation.get(app_id)
 
 
 class WorkflowNodeInvocations:
@@ -219,7 +223,7 @@ class BackwardsInvocation(Generic[T], ABC):
             try:
                 yield data_type(**event.data)
             except Exception as e:
-                raise Exception(f"Failed to parse response: {str(e)}") from e
+                raise Exception(f"Failed to parse response: {e!s}") from e
 
     def _http_backwards_invoke(
         self,
@@ -271,7 +275,7 @@ class BackwardsInvocation(Generic[T], ABC):
                     if not line:
                         continue
 
-                    data = json.loads(line)
+                    data = TypeAdapter(dict[str, Any]).validate_json(line)
                     yield PluginInStreamBase(
                         session_id=data["session_id"],
                         event=PluginInStreamEvent.value_of(data["event"]),

dify_plugin-0.2.0/dify_plugin/core/server/__base/request_reader.py

@@ -0,0 +1,114 @@
+import logging
+import threading
+import time
+from abc import ABC, abstractmethod
+from collections.abc import Callable, Generator
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from dify_plugin.core.entities.plugin.io import PluginInStream
+
+from dify_plugin.core.server.__base.filter_reader import (
+    FilterReader,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class RequestReader(ABC):
+    def __init__(self):
+        # Convert class variables to instance variables to avoid global lock contention
+        self.lock = threading.Lock()
+        self.readers = []
+
+    @abstractmethod
+    def _read_stream(self) -> Generator["PluginInStream", None, None]:
+        """
+        Read stream from stdin
+        """
+        raise NotImplementedError
+
+    def event_loop(self):
+        # read line by line
+        while True:
+            try:
+                for line in self._read_stream():
+                    self._process_line(line)
+            except Exception:
+                logger.exception("Error in event loop")
+                time.sleep(0.01)  # Prevent high CPU usage
+
+    def _process_line(self, data: "PluginInStream"):
+        try:
+            session_id = data.session_id
+            readers_to_process = []
+
+            # Acquire lock to safely access readers list
+            self.lock.acquire()
+            try:
+                # Safely copy the reader list under lock protection
+                readers_to_process = self.readers.copy()
+            finally:
+                self.lock.release()
+
+            # Execute filter operations outside of lock
+            matched_readers = []
+            for reader in readers_to_process:
+                try:
+                    result = reader.filter(data)
+                    if result:
+                        matched_readers.append(reader)
+                except Exception:
+                    logger.exception("Error in filter")
+
+            # Process readers in batches to avoid blocking
+            for reader in matched_readers:
+                try:
+                    reader.write(data)
+                except Exception:
+                    logger.exception("Error writing to reader")
+
+        except Exception as e:
+            data.writer.error(
+                session_id=session_id,
+                data={"error": f"Failed to process request ({type(e).__name__}): {e!s}"},
+            )
+
+    def read(self, filter: Callable[["PluginInStream"], bool]) -> FilterReader:  # noqa: A002
+        def close(reader: FilterReader):
+            self.lock.acquire()
+            try:
+                if reader in self.readers:
+                    self.readers.remove(reader)
+            finally:
+                self.lock.release()
+
+        reader = FilterReader(filter, close_callback=lambda: close(reader))
+
+        self.lock.acquire()
+        try:
+            self.readers.append(reader)
+        finally:
+            self.lock.release()
+
+        return reader
+
+    def close(self):
+        """
+        close stdin processing
+        """
+        readers_to_close = []
+
+        self.lock.acquire()
+        try:
+            readers_to_close = self.readers.copy()
+            self.readers.clear()
+        finally:
+            self.lock.release()
+
+        # Close readers outside the lock
+        for reader in readers_to_close:
+            try:
+                reader.close()
+            except Exception:
+                logger.exception("Error closing reader")

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/server/serverless/request_reader.py

@@ -1,7 +1,7 @@
 import threading
+import time
 from collections.abc import Generator
 from queue import Empty, Queue
-import time
 
 from flask import Flask, request
 
@@ -27,6 +27,7 @@ class ServerlessRequestReader(RequestReader):
         """
         Initialize the ServerlessStream and wait for jobs
         """
+        super().__init__()
         self.app = Flask(__name__)
         self.host = host
         self.port = port
@@ -94,6 +95,7 @@ class ServerlessRequestReader(RequestReader):
         self.app.route("/health", methods=["GET"])(self.health)
 
         import socket
+
         import gevent.socket
 
         if socket.socket is gevent.socket.socket:
@@ -101,7 +103,7 @@ class ServerlessRequestReader(RequestReader):
 
             server = WSGIServer((self.host, self.port), self.app)
             print("* Serving Flask app 'dify_plugin.core.server.serverless.request_reader'")
-            print("* Running on http://%s:%d (Press CTRL+C to quit)" % (self.host, self.port))
+            print(f"* Running on http://{self.host}:{self.port} (Press CTRL+C to quit)")
             print("* Server Worker: gevent.wsgi.WSGIServer", flush=True)
             server.serve_forever()
         else:

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/server/stdio/request_reader.py

@@ -1,8 +1,9 @@
 import sys
 from collections.abc import Generator
-from json import loads
+from typing import Any
 
 from gevent.os import tp_read
+from pydantic import TypeAdapter
 
 from dify_plugin.core.entities.plugin.io import (
     PluginInStream,
@@ -13,6 +14,9 @@ from dify_plugin.core.server.stdio.response_writer import StdioResponseWriter
 
 
 class StdioRequestReader(RequestReader):
+    def __init__(self):
+        super().__init__()
+
     def _read_stream(self) -> Generator[PluginInStream, None, None]:
         buffer = b""
         while True:
@@ -34,9 +38,13 @@ class StdioRequestReader(RequestReader):
             lines = lines[:-1]
             for line in lines:
                 try:
-                    data = loads(line)
+                    data = TypeAdapter(dict[str, Any]).validate_json(line)
                     yield PluginInStream(
                         session_id=data["session_id"],
+                        conversation_id=data.get("conversation_id"),
+                        message_id=data.get("message_id"),
+                        app_id=data.get("app_id"),
+                        endpoint_id=data.get("endpoint_id"),
                         event=PluginInStreamEvent.value_of(data["event"]),
                         data=data["data"],
                         reader=self,

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/core/server/tcp/request_reader.py

@@ -2,18 +2,18 @@ import errno
 import logging
 import os
 import signal
-from threading import Lock
-import time
 import socket as native_socket
-from collections.abc import Generator
-from json import loads
-from typing import Callable, Optional
+import time
+from collections.abc import Callable, Generator
+from threading import Lock
+from typing import Any, Optional
 
+from gevent import sleep
+from gevent import socket as gevent_socket
 from gevent.select import select
-from gevent import socket as gevent_socket, sleep
+from pydantic import TypeAdapter
 
 from dify_plugin.core.entities.message import InitializeMessage
-
 from dify_plugin.core.entities.plugin.io import (
     PluginInStream,
     PluginInStreamEvent,
@@ -37,6 +37,8 @@ class TCPReaderWriter(RequestReader, ResponseWriter):
         """
         Initialize the TCPStream and connect to the target, raise exception if connection failed
         """
+        super().__init__()
+
         self.host = host
         self.port = port
         self.key = key
@@ -188,9 +190,13 @@ class TCPReaderWriter(RequestReader, ResponseWriter):
             lines = lines[:-1]
             for line in lines:
                 try:
-                    data = loads(line)
+                    data = TypeAdapter(dict[str, Any]).validate_json(line)
                     chunk = PluginInStream(
                         session_id=data["session_id"],
+                        conversation_id=data.get("conversation_id"),
+                        message_id=data.get("message_id"),
+                        app_id=data.get("app_id"),
+                        endpoint_id=data.get("endpoint_id"),
                         event=PluginInStreamEvent.value_of(data["event"]),
                         data=data["data"],
                         reader=self,

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/entities/agent.py

@@ -45,6 +45,7 @@ class AgentStrategyParameter(BaseModel):
 
     name: str = Field(..., description="The name of the parameter")
     label: I18nObject = Field(..., description="The label presented to the user")
+    help: Optional[I18nObject] = None
     type: ToolParameterType = Field(..., description="The type of the parameter")
     auto_generate: Optional[ParameterAutoGenerate] = Field(
         default=None, description="The auto generate of the parameter"
@@ -115,7 +116,7 @@ class AgentStrategyProviderConfiguration(BaseModel):
                     )
                 )
             except Exception as e:
-                raise ValueError(f"Error loading agent strategy configuration: {str(e)}") from e
+                raise ValueError(f"Error loading agent strategy configuration: {e!s}") from e
 
         return strategies
 

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/entities/endpoint.py

@@ -38,6 +38,6 @@ class EndpointProviderConfiguration(BaseModel):
                 file = load_yaml_file(endpoint)
                 endpoints.append(EndpointConfiguration(**file))
             except Exception as e:
-                raise ValueError(f"Error loading endpoint configuration: {str(e)}") from e
+                raise ValueError(f"Error loading endpoint configuration: {e!s}") from e
 
         return endpoints

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/entities/model/__init__.py

@@ -199,6 +199,7 @@ class ModelFeature(Enum):
     DOCUMENT = "document"
     VIDEO = "video"
     AUDIO = "audio"
+    STRUCTURED_OUTPUT = "structured-output"
 
 
 class ParameterType(Enum):

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/entities/model/llm.py

@@ -2,7 +2,7 @@ from decimal import Decimal
 from enum import Enum
 from typing import Optional
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 from dify_plugin.entities.model import BaseModelConfig, ModelType, ModelUsage, PriceInfo
 from dify_plugin.entities.model.message import (
@@ -86,10 +86,25 @@ class LLMResultChunk(BaseModel):
     """
 
     model: str
-    prompt_messages: list[PromptMessage]
+    prompt_messages: list[PromptMessage] = Field(default_factory=list)
     system_fingerprint: Optional[str] = None
     delta: LLMResultChunkDelta
 
+    @field_validator("prompt_messages", mode="before")
+    @classmethod
+    def transform_prompt_messages(cls, value):
+        """
+        ISSUE:
+        - https://github.com/langgenius/dify/issues/17799
+        - https://github.com/langgenius/dify-official-plugins/issues/648
+
+        The `prompt_messages` field is deprecated, but to keep backward compatibility
+        we need to always set it to an empty list.
+
+        NOTE: just do not use it anymore, it will be removed in the future.
+        """
+        return []
+
 
 class LLMResult(BaseModel):
     """
@@ -97,15 +112,29 @@ class LLMResult(BaseModel):
     """
 
     model: str
-    prompt_messages: list[PromptMessage]
+    prompt_messages: list[PromptMessage] = Field(default_factory=list)
     message: AssistantPromptMessage
     usage: LLMUsage
     system_fingerprint: Optional[str] = None
 
+    @field_validator("prompt_messages", mode="before")
+    @classmethod
+    def transform_prompt_messages(cls, value):
+        """
+        ISSUE:
+        - https://github.com/langgenius/dify/issues/17799
+        - https://github.com/langgenius/dify-official-plugins/issues/648
+
+        The `prompt_messages` field is deprecated, but to keep backward compatibility
+        we need to always set it to an empty list.
+
+        NOTE: just do not use it anymore, it will be removed in the future.
+        """
+        return []
+
     def to_llm_result_chunk(self) -> "LLMResultChunk":
         return LLMResultChunk(
             model=self.model,
-            prompt_messages=self.prompt_messages,
             system_fingerprint=self.system_fingerprint,
             delta=LLMResultChunkDelta(
                 index=0,

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/entities/model/message.py

@@ -2,7 +2,7 @@ from collections.abc import Sequence
 from enum import Enum, StrEnum
 from typing import Annotated, Literal, Optional, Union
 
-from pydantic import BaseModel, Field, field_validator, BeforeValidator
+from pydantic import BaseModel, BeforeValidator, Field, field_validator
 
 
 class PromptMessageRole(Enum):
@@ -188,6 +188,7 @@ def _ensure_field_empty_str(value: Optional[str]) -> str:
         return ""
     return value
 
+
 class AssistantPromptMessage(PromptMessage):
     """
     Model class for assistant prompt message.

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/entities/tool.py

@@ -81,7 +81,7 @@ class ToolInvokeMessage(BaseModel):
             return {"text": self.text}
 
     class JsonMessage(BaseModel):
-        json_object: dict
+        json_object: Mapping
 
         def to_dict(self):
             return {"json_object": self.json_object}
@@ -384,7 +384,7 @@ class ToolProviderConfiguration(BaseModel):
                     )
                 )
             except Exception as e:
-                raise ValueError(f"Error loading tool configuration: {str(e)}") from e
+                raise ValueError(f"Error loading tool configuration: {e!s}") from e
 
         return tools
 

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/interfaces/agent/__init__.py

@@ -28,7 +28,7 @@ class AgentToolIdentity(ToolIdentity):
 
 class AgentModelConfig(LLMModelConfig):
     entity: AIModelEntity | None = None
-    history_prompt_messages: list[PromptMessage] = []
+    history_prompt_messages: list[PromptMessage] = Field(default_factory=list)
 
     @field_validator("history_prompt_messages", mode="before")
     @classmethod
@@ -277,6 +277,11 @@ class AgentStrategy(ToolLike[AgentInvokeMessage]):
                 ToolParameter.ToolParameterType.FILES,
             }:
                 continue
+            if parameter.type in {
+                ToolParameter.ToolParameterType.SELECT,
+                ToolParameter.ToolParameterType.SECRET_INPUT,
+            }:
+                parameter_type = ToolParameter.ToolParameterType.STRING
             enum = []
             if parameter.type == ToolParameter.ToolParameterType.SELECT:
                 enum = [option.value for option in parameter.options] if parameter.options else []
@@ -311,6 +316,11 @@ class AgentStrategy(ToolLike[AgentInvokeMessage]):
                 ToolParameter.ToolParameterType.FILES,
             }:
                 continue
+            if parameter.type in {
+                ToolParameter.ToolParameterType.SELECT,
+                ToolParameter.ToolParameterType.SECRET_INPUT,
+            }:
+                parameter_type = ToolParameter.ToolParameterType.STRING
             enum = []
             if parameter.type == ToolParameter.ToolParameterType.SELECT:
                 enum = [option.value for option in parameter.options] if parameter.options else []

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/interfaces/model/ai_model.py

@@ -1,4 +1,5 @@
 import decimal
+import socket
 from abc import ABC, abstractmethod
 from collections.abc import Mapping
 from typing import Optional
@@ -18,8 +19,6 @@ from dify_plugin.entities.model import (
 )
 from dify_plugin.errors.model import InvokeAuthorizationError, InvokeError
 
-import socket
-
 if socket.socket is gevent.socket.socket:
     import gevent.threadpool
 
@@ -84,9 +83,9 @@ class AIModel(ABC):
                         "please check and try again. "
                     )
 
-                return invoke_error(description=f"[{provider_name}] {invoke_error.description}, {str(error)}")
+                return invoke_error(description=f"[{provider_name}] {invoke_error.description}, {error!s}")
 
-        return InvokeError(description=f"[{provider_name}] Error: {str(error)}")
+        return InvokeError(description=f"[{provider_name}] Error: {error!s}")
 
     def get_price(self, model: str, credentials: dict, price_type: PriceType, tokens: int) -> PriceInfo:
         """
@@ -271,11 +270,11 @@ class AIModel(ABC):
         if len(text) >= 100000:
             return len(text)
 
-        import tiktoken
-
         # check if gevent is patched to main thread
         import socket
 
+        import tiktoken
+
         if socket.socket is gevent.socket.socket:
             # using gevent real thread to avoid blocking main thread
             result = threadpool.spawn(lambda: len(tiktoken.encoding_for_model("gpt2").encode(text)))

{dify_plugin-0.1.0 → dify_plugin-0.2.0}/dify_plugin/interfaces/model/large_language_model.py

@@ -440,7 +440,6 @@ if you are not sure about the structure.
             if new_piece:
                 yield LLMResultChunk(
                     model=model,
-                    prompt_messages=prompt_messages,
                     delta=LLMResultChunkDelta(
                         index=0,
                         message=AssistantPromptMessage(content=new_piece, tool_calls=[]),
@@ -515,7 +514,6 @@ if you are not sure about the structure.
                 # Only yield content collected within the code block
                 yield LLMResultChunk(
                     model=model,
-                    prompt_messages=prompt_messages,
                     delta=LLMResultChunkDelta(
                         index=0,
                         message=AssistantPromptMessage(content=new_piece, tool_calls=[]),