dify-oapi2 0.3.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

dify_oapi/api/workflow/v1/model/{info/app_info.py → app_info.py}

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from ..workflow.workflow_types import AppMode
+from .workflow_types import AppMode
 
 
 class AppInfo(BaseModel):

dify_oapi/api/workflow/v1/model/file_upload_info.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class FileUploadInfo(BaseModel):
+    id: str | None = None
+    name: str | None = None
+    size: int | None = None
+    extension: str | None = None
+    mime_type: str | None = None
+    created_by: str | None = None
+    created_at: int | None = None
+
+    @staticmethod
+    def builder() -> FileUploadInfoBuilder:
+        return FileUploadInfoBuilder()
+
+
+class FileUploadInfoBuilder:
+    def __init__(self):
+        self._file_upload_info = FileUploadInfo()
+
+    def build(self) -> FileUploadInfo:
+        return self._file_upload_info
+
+    def id(self, id: str) -> FileUploadInfoBuilder:
+        self._file_upload_info.id = id
+        return self
+
+    def name(self, name: str) -> FileUploadInfoBuilder:
+        self._file_upload_info.name = name
+        return self
+
+    def size(self, size: int) -> FileUploadInfoBuilder:
+        self._file_upload_info.size = size
+        return self
+
+    def extension(self, extension: str) -> FileUploadInfoBuilder:
+        self._file_upload_info.extension = extension
+        return self
+
+    def mime_type(self, mime_type: str) -> FileUploadInfoBuilder:
+        self._file_upload_info.mime_type = mime_type
+        return self
+
+    def created_by(self, created_by: str) -> FileUploadInfoBuilder:
+        self._file_upload_info.created_by = created_by
+        return self
+
+    def created_at(self, created_at: int) -> FileUploadInfoBuilder:
+        self._file_upload_info.created_at = created_at
+        return self

dify_oapi/api/workflow/v1/model/{log/get_workflow_logs_response.py → get_workflow_logs_response.py}

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from dify_oapi.core.model.base_response import BaseResponse
 
-from .log_info import LogInfo
+from .workflow_log_info import WorkflowLogInfo
 
 
 class GetWorkflowLogsResponse(BaseResponse):
@@ -10,4 +10,4 @@ class GetWorkflowLogsResponse(BaseResponse):
     limit: int | None = None
     total: int | None = None
     has_more: bool | None = None
-    data: list[LogInfo] | None = None
+    data: list[WorkflowLogInfo] | None = None

dify_oapi/api/workflow/v1/model/{workflow/get_workflow_run_detail_response.py → get_workflow_run_detail_response.py}

@@ -1,7 +1,10 @@
 from __future__ import annotations
 
+import json
 from typing import Any
 
+from pydantic import field_validator
+
 from dify_oapi.core.model.base_response import BaseResponse
 
 from .workflow_types import WorkflowStatus
@@ -19,3 +22,18 @@ class GetWorkflowRunDetailResponse(BaseResponse):
     created_at: int | None = None
     finished_at: int | None = None
     elapsed_time: float | None = None
+
+    @field_validator("inputs", "outputs", mode="before")
+    @classmethod
+    def parse_json_fields(cls, v: Any) -> dict[str, Any] | None:
+        if v is None:
+            return None
+        if isinstance(v, str):
+            try:
+                parsed = json.loads(v)
+                return parsed if isinstance(parsed, dict) else {}
+            except (json.JSONDecodeError, TypeError):
+                return {}
+        if isinstance(v, dict):
+            return v
+        return {}

dify_oapi/api/workflow/v1/model/{info/site_info.py → site_info.py}

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from ..workflow.workflow_types import IconType
+from .workflow_types import IconType
 
 
 class SiteInfo(BaseModel):

dify_oapi/api/workflow/v1/model/{file/upload_file_response.py → upload_file_response.py}

@@ -2,8 +2,8 @@ from __future__ import annotations
 
 from dify_oapi.core.model.base_response import BaseResponse
 
-from .file_info import FileInfo
+from .file_upload_info import FileUploadInfo
 
 
-class UploadFileResponse(FileInfo, BaseResponse):
+class UploadFileResponse(FileUploadInfo, BaseResponse):
     pass

dify_oapi/api/workflow/v1/model/workflow_log_info.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .end_user_info import EndUserInfo
+from .workflow_run_log_info import WorkflowRunLogInfo
+from .workflow_types import CreatedByRole, CreatedFrom
+
+
+class WorkflowLogInfo(BaseModel):
+    id: str | None = None
+    workflow_run: WorkflowRunLogInfo | None = None
+    created_from: CreatedFrom | None = None
+    created_by_role: CreatedByRole | None = None
+    created_by_account: str | None = None
+    created_by_end_user: EndUserInfo | None = None
+    created_at: int | None = None
+
+    @staticmethod
+    def builder() -> WorkflowLogInfoBuilder:
+        return WorkflowLogInfoBuilder()
+
+
+class WorkflowLogInfoBuilder:
+    def __init__(self):
+        self._workflow_log_info = WorkflowLogInfo()
+
+    def build(self) -> WorkflowLogInfo:
+        return self._workflow_log_info
+
+    def id(self, id: str) -> WorkflowLogInfoBuilder:
+        self._workflow_log_info.id = id
+        return self
+
+    def workflow_run(self, workflow_run: WorkflowRunLogInfo) -> WorkflowLogInfoBuilder:
+        self._workflow_log_info.workflow_run = workflow_run
+        return self
+
+    def created_from(self, created_from: CreatedFrom) -> WorkflowLogInfoBuilder:
+        self._workflow_log_info.created_from = created_from
+        return self
+
+    def created_by_role(self, created_by_role: CreatedByRole) -> WorkflowLogInfoBuilder:
+        self._workflow_log_info.created_by_role = created_by_role
+        return self
+
+    def created_by_account(self, created_by_account: str) -> WorkflowLogInfoBuilder:
+        self._workflow_log_info.created_by_account = created_by_account
+        return self
+
+    def created_by_end_user(self, created_by_end_user: EndUserInfo) -> WorkflowLogInfoBuilder:
+        self._workflow_log_info.created_by_end_user = created_by_end_user
+        return self
+
+    def created_at(self, created_at: int) -> WorkflowLogInfoBuilder:
+        self._workflow_log_info.created_at = created_at
+        return self

dify_oapi/api/workflow/v1/model/{log/workflow_run_log_info.py → workflow_run_log_info.py}

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from ..workflow.workflow_types import LogStatus
+from .workflow_types import LogStatus
 
 
 class WorkflowRunLogInfo(BaseModel):

dify_oapi/api/workflow/v1/resource/workflow.py

@@ -5,14 +5,22 @@ from dify_oapi.core.http.transport import ATransport, Transport
 from dify_oapi.core.model.config import Config
 from dify_oapi.core.model.request_option import RequestOption
 
-from ..model.workflow.get_workflow_run_detail_request import GetWorkflowRunDetailRequest
-from ..model.workflow.get_workflow_run_detail_response import GetWorkflowRunDetailResponse
-from ..model.workflow.run_specific_workflow_request import RunSpecificWorkflowRequest
-from ..model.workflow.run_specific_workflow_response import RunSpecificWorkflowResponse
-from ..model.workflow.run_workflow_request import RunWorkflowRequest
-from ..model.workflow.run_workflow_response import RunWorkflowResponse
-from ..model.workflow.stop_workflow_request import StopWorkflowRequest
-from ..model.workflow.stop_workflow_response import StopWorkflowResponse
+from ..model.get_info_request import GetInfoRequest
+from ..model.get_info_response import GetInfoResponse
+from ..model.get_parameters_request import GetParametersRequest
+from ..model.get_parameters_response import GetParametersResponse
+from ..model.get_site_request import GetSiteRequest
+from ..model.get_site_response import GetSiteResponse
+from ..model.get_workflow_logs_request import GetWorkflowLogsRequest
+from ..model.get_workflow_logs_response import GetWorkflowLogsResponse
+from ..model.get_workflow_run_detail_request import GetWorkflowRunDetailRequest
+from ..model.get_workflow_run_detail_response import GetWorkflowRunDetailResponse
+from ..model.run_workflow_request import RunWorkflowRequest
+from ..model.run_workflow_response import RunWorkflowResponse
+from ..model.stop_workflow_request import StopWorkflowRequest
+from ..model.stop_workflow_response import StopWorkflowResponse
+from ..model.upload_file_request import UploadFileRequest
+from ..model.upload_file_response import UploadFileResponse
 
 
 class Workflow:
@@ -20,7 +28,7 @@ class Workflow:
         self.config = config
 
     @overload
-    def run_workflow(
+    def run(
         self,
         request: RunWorkflowRequest,
         request_option: RequestOption,
@@ -28,35 +36,25 @@ class Workflow:
     ) -> Generator[bytes, None, None]: ...
 
     @overload
-    def run_workflow(
+    def run(
         self,
         request: RunWorkflowRequest,
         request_option: RequestOption,
         stream: Literal[False] = False,
     ) -> RunWorkflowResponse: ...
 
-    def run_workflow(
+    def run(
         self,
         request: RunWorkflowRequest,
         request_option: RequestOption,
         stream: bool = False,
     ) -> RunWorkflowResponse | Generator[bytes, None, None]:
-        """Execute workflow.
-
-        Args:
-            request: The run workflow request
-            request_option: Request options including API key
-            stream: Whether to use streaming mode
-
-        Returns:
-            RunWorkflowResponse for blocking mode or Generator[bytes, None, None] for streaming mode
-        """
         if stream:
             return Transport.execute(self.config, request, stream=True, option=request_option)
         return Transport.execute(self.config, request, unmarshal_as=RunWorkflowResponse, option=request_option)
 
     @overload
-    async def arun_workflow(
+    async def arun(
         self,
         request: RunWorkflowRequest,
         request_option: RequestOption,
@@ -64,157 +62,71 @@ class Workflow:
     ) -> AsyncGenerator[bytes, None]: ...
 
     @overload
-    async def arun_workflow(
+    async def arun(
         self,
         request: RunWorkflowRequest,
         request_option: RequestOption,
         stream: Literal[False] = False,
     ) -> RunWorkflowResponse: ...
 
-    async def arun_workflow(
+    async def arun(
         self,
         request: RunWorkflowRequest,
         request_option: RequestOption,
         stream: bool = False,
     ) -> RunWorkflowResponse | AsyncGenerator[bytes, None]:
-        """Execute workflow asynchronously.
-
-        Args:
-            request: The run workflow request
-            request_option: Request options including API key
-            stream: Whether to use streaming mode
-
-        Returns:
-            RunWorkflowResponse for blocking mode or AsyncGenerator[bytes, None] for streaming mode
-        """
         if stream:
             return await ATransport.aexecute(self.config, request, stream=True, option=request_option)
         return await ATransport.aexecute(self.config, request, unmarshal_as=RunWorkflowResponse, option=request_option)
 
-    @overload
-    def run_specific_workflow(
-        self,
-        request: RunSpecificWorkflowRequest,
-        request_option: RequestOption,
-        stream: Literal[True],
-    ) -> Generator[bytes, None, None]: ...
-
-    @overload
-    def run_specific_workflow(
-        self,
-        request: RunSpecificWorkflowRequest,
-        request_option: RequestOption,
-        stream: Literal[False] = False,
-    ) -> RunSpecificWorkflowResponse: ...
-
-    def run_specific_workflow(
-        self,
-        request: RunSpecificWorkflowRequest,
-        request_option: RequestOption,
-        stream: bool = False,
-    ) -> RunSpecificWorkflowResponse | Generator[bytes, None, None]:
-        """Execute specific version workflow.
-
-        Args:
-            request: The run specific workflow request
-            request_option: Request options including API key
-            stream: Whether to use streaming mode
-
-        Returns:
-            RunSpecificWorkflowResponse for blocking mode or Generator[bytes, None, None] for streaming mode
-        """
-        if stream:
-            return Transport.execute(self.config, request, stream=True, option=request_option)
-        return Transport.execute(self.config, request, unmarshal_as=RunSpecificWorkflowResponse, option=request_option)
-
-    @overload
-    async def arun_specific_workflow(
-        self,
-        request: RunSpecificWorkflowRequest,
-        request_option: RequestOption,
-        stream: Literal[True],
-    ) -> AsyncGenerator[bytes, None]: ...
-
-    @overload
-    async def arun_specific_workflow(
-        self,
-        request: RunSpecificWorkflowRequest,
-        request_option: RequestOption,
-        stream: Literal[False] = False,
-    ) -> RunSpecificWorkflowResponse: ...
-
-    async def arun_specific_workflow(
-        self,
-        request: RunSpecificWorkflowRequest,
-        request_option: RequestOption,
-        stream: bool = False,
-    ) -> RunSpecificWorkflowResponse | AsyncGenerator[bytes, None]:
-        """Execute specific version workflow asynchronously.
-
-        Args:
-            request: The run specific workflow request
-            request_option: Request options including API key
-            stream: Whether to use streaming mode
+    def detail(
+        self, request: GetWorkflowRunDetailRequest, request_option: RequestOption
+    ) -> GetWorkflowRunDetailResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetWorkflowRunDetailResponse, option=request_option)
 
-        Returns:
-            RunSpecificWorkflowResponse for blocking mode or AsyncGenerator[bytes, None] for streaming mode
-        """
-        if stream:
-            return await ATransport.aexecute(self.config, request, stream=True, option=request_option)
+    async def adetail(
+        self, request: GetWorkflowRunDetailRequest, request_option: RequestOption
+    ) -> GetWorkflowRunDetailResponse:
         return await ATransport.aexecute(
-            self.config, request, unmarshal_as=RunSpecificWorkflowResponse, option=request_option
+            self.config, request, unmarshal_as=GetWorkflowRunDetailResponse, option=request_option
         )
 
-    def get_workflow_run_detail(
-        self, request: GetWorkflowRunDetailRequest, request_option: RequestOption
-    ) -> GetWorkflowRunDetailResponse:
-        """Get workflow execution details.
+    def stop(self, request: StopWorkflowRequest, request_option: RequestOption) -> StopWorkflowResponse:
+        return Transport.execute(self.config, request, unmarshal_as=StopWorkflowResponse, option=request_option)
 
-        Args:
-            request: The get workflow run detail request
-            request_option: Request options including API key
+    async def astop(self, request: StopWorkflowRequest, request_option: RequestOption) -> StopWorkflowResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=StopWorkflowResponse, option=request_option)
 
-        Returns:
-            GetWorkflowRunDetailResponse with workflow execution details
-        """
-        return Transport.execute(self.config, request, unmarshal_as=GetWorkflowRunDetailResponse, option=request_option)
+    def upload(self, request: UploadFileRequest, request_option: RequestOption) -> UploadFileResponse:
+        return Transport.execute(self.config, request, unmarshal_as=UploadFileResponse, option=request_option)
 
-    async def aget_workflow_run_detail(
-        self, request: GetWorkflowRunDetailRequest, request_option: RequestOption
-    ) -> GetWorkflowRunDetailResponse:
-        """Get workflow execution details asynchronously.
+    async def aupload(self, request: UploadFileRequest, request_option: RequestOption) -> UploadFileResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=UploadFileResponse, option=request_option)
 
-        Args:
-            request: The get workflow run detail request
-            request_option: Request options including API key
+    def logs(self, request: GetWorkflowLogsRequest, request_option: RequestOption) -> GetWorkflowLogsResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetWorkflowLogsResponse, option=request_option)
 
-        Returns:
-            GetWorkflowRunDetailResponse with workflow execution details
-        """
+    async def alogs(self, request: GetWorkflowLogsRequest, request_option: RequestOption) -> GetWorkflowLogsResponse:
         return await ATransport.aexecute(
-            self.config, request, unmarshal_as=GetWorkflowRunDetailResponse, option=request_option
+            self.config, request, unmarshal_as=GetWorkflowLogsResponse, option=request_option
         )
 
-    def stop_workflow(self, request: StopWorkflowRequest, request_option: RequestOption) -> StopWorkflowResponse:
-        """Stop workflow execution.
+    def info(self, request: GetInfoRequest, request_option: RequestOption) -> GetInfoResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetInfoResponse, option=request_option)
 
-        Args:
-            request: The stop workflow request
-            request_option: Request options including API key
+    async def ainfo(self, request: GetInfoRequest, request_option: RequestOption) -> GetInfoResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=GetInfoResponse, option=request_option)
 
-        Returns:
-            StopWorkflowResponse with stop result
-        """
-        return Transport.execute(self.config, request, unmarshal_as=StopWorkflowResponse, option=request_option)
+    def parameters(self, request: GetParametersRequest, request_option: RequestOption) -> GetParametersResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetParametersResponse, option=request_option)
 
-    async def astop_workflow(self, request: StopWorkflowRequest, request_option: RequestOption) -> StopWorkflowResponse:
-        """Stop workflow execution asynchronously.
+    async def aparameters(self, request: GetParametersRequest, request_option: RequestOption) -> GetParametersResponse:
+        return await ATransport.aexecute(
+            self.config, request, unmarshal_as=GetParametersResponse, option=request_option
+        )
 
-        Args:
-            request: The stop workflow request
-            request_option: Request options including API key
+    def site(self, request: GetSiteRequest, request_option: RequestOption) -> GetSiteResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetSiteResponse, option=request_option)
 
-        Returns:
-            StopWorkflowResponse with stop result
-        """
-        return await ATransport.aexecute(self.config, request, unmarshal_as=StopWorkflowResponse, option=request_option)
+    async def asite(self, request: GetSiteRequest, request_option: RequestOption) -> GetSiteResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=GetSiteResponse, option=request_option)

dify_oapi/api/workflow/v1/version.py

@@ -1,14 +1,8 @@
 from dify_oapi.core.model.config import Config
 
-from .resource.file import File
-from .resource.info import Info
-from .resource.log import Log
 from .resource.workflow import Workflow
 
 
 class V1:
     def __init__(self, config: Config):
-        self.workflow: Workflow = Workflow(config)
-        self.file: File = File(config)
-        self.log: Log = Log(config)
-        self.info: Info = Info(config)
+        self.workflow = Workflow(config)

dify_oapi/client.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from .api.chat.service import ChatService
 from .api.completion.service import CompletionService
 from .api.dify.service import DifyService
-from .api.knowledge_base.service import KnowledgeBaseService
+from .api.knowledge.service import Knowledge
 from .api.workflow.service import WorkflowService
 from .core.enum import LogLevel
 from .core.http.transport import Transport
@@ -19,7 +19,7 @@ class Client:
         self._completion: CompletionService | None = None
         self._dify: DifyService | None = None
         self._workflow: WorkflowService | None = None
-        self._knowledge_base: KnowledgeBaseService | None = None
+        self._knowledge: Knowledge | None = None
 
     @property
     def chat(self) -> ChatService:
@@ -46,10 +46,10 @@ class Client:
         return self._workflow
 
     @property
-    def knowledge_base(self) -> KnowledgeBaseService:
-        if self._knowledge_base is None:
+    def knowledge(self) -> Knowledge:
+        if self._knowledge is None:
             raise RuntimeError("Knowledge base service has not been initialized")
-        return self._knowledge_base
+        return self._knowledge
 
     def request(self, request: BaseRequest):
         if self._config is None:
@@ -90,7 +90,7 @@ class ClientBuilder:
         client._completion = CompletionService(self._config)
         client._dify = DifyService(self._config)
         client._workflow = WorkflowService(self._config)
-        client._knowledge_base = KnowledgeBaseService(self._config)
+        client._knowledge = Knowledge(self._config)
         return client
 
     def _init_logger(self):

{dify_oapi2-0.3.0.dist-info → dify_oapi2-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dify-oapi2
-Version: 0.3.0
+Version: 0.4.0
 Summary: A package for interacting with the Dify Service-API
 License: MIT
 Keywords: dify,nlp,ai,language-processing
@@ -31,7 +31,7 @@ A Python SDK for interacting with the Dify Service-API. This library provides a
 
 ## ✨ Features
 
-- **Multiple API Services**: Chat, Completion, Knowledge Base (39 APIs), Workflow, and Core Dify APIs
+- **Multiple API Services**: Chat, Completion, Knowledge Base (33 APIs), Workflow, and Core Dify APIs
 - **Builder Pattern**: Fluent, chainable interface for constructing requests
 - **Sync & Async Support**: Both synchronous and asynchronous operations
 - **Streaming Responses**: Real-time streaming for chat and completion
@@ -130,12 +130,13 @@ asyncio.run(async_chat())
 - **File Upload**: Support for document and media files
 - **Application Info**: Configuration and metadata retrieval
 
-### Knowledge Base API (39 APIs)
-- **Dataset Management**: CRUD operations for datasets
-- **Document Management**: Upload, process, and manage documents
-- **Segment Management**: Fine-grained content segmentation
-- **Metadata & Tags**: Custom metadata and knowledge type tags
-- **Retrieval**: Advanced search and retrieval functionality
+### Knowledge Base API (33 APIs)
+- **Dataset Management**: 6 APIs for dataset CRUD operations and content retrieval
+- **Document Management**: 10 APIs for document upload, processing, and management
+- **Segment Management**: 5 APIs for fine-grained content segmentation
+- **Child Chunks Management**: 4 APIs for sub-segment management
+- **Tag Management**: 7 APIs for metadata and knowledge type tags
+- **Model Management**: 1 API for embedding model information
 
 ### Workflow API
 - Automated workflow execution
@@ -158,7 +159,10 @@ Explore comprehensive examples in the [examples directory](./examples):
 - [**Basic Completion**](./examples/completion/basic_completion.py) - Text generation
 
 ### Knowledge Base Examples
-- [**List Datasets**](./examples/knowledge_base/list_datasets.py) - Dataset management
+- [**Dataset Management**](./examples/knowledge/dataset/) - Complete dataset operations
+- [**Document Processing**](./examples/knowledge/document/) - File upload and text processing
+- [**Content Organization**](./examples/knowledge/segment/) - Segment and chunk management
+- [**Tag Management**](./examples/knowledge/tag/) - Metadata and tagging system
 
 For detailed examples and usage patterns, see the [examples README](./examples/README.md).
 
@@ -248,7 +252,7 @@ dify-oapi/
 │   │   ├── chat/        # Chat API
 │   │   ├── completion/  # Completion API
 │   │   ├── dify/        # Core Dify API
-│   │   ├── knowledge_base/ # Knowledge Base API (39 APIs)
+│   │   ├── knowledge/ # Knowledge Base API (33 APIs)
 │   │   └── workflow/    # Workflow API
 │   ├── core/            # Core functionality
 │   │   ├── http/        # HTTP transport layer
@@ -265,7 +269,7 @@ dify-oapi/
 
 - [**Project Overview**](./docs/overview.md) - Architecture and technical details
 - [**Completion APIs**](./docs/completion/apis.md) - Complete completion API documentation
-- [**Knowledge Base APIs**](./docs/datasets/apis.md) - Complete dataset API documentation
+- [**Knowledge Base APIs**](./docs/knowledge/apis.md) - Complete knowledge base API documentation
 - [**Examples**](./examples/README.md) - Usage examples and patterns
 
 ## 🤝 Contributing