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

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

@@ -0,0 +1,54 @@
+from typing import Literal
+
+# Response mode types
+ResponseMode = Literal["streaming", "blocking"]
+
+# File types
+FileType = Literal["document", "image", "audio", "video", "custom"]
+
+# Transfer method types
+TransferMethod = Literal["remote_url", "local_file"]
+
+# Workflow status types
+WorkflowStatus = Literal["running", "succeeded", "failed", "stopped"]
+
+# Event types
+EventType = Literal[
+    "workflow_started",
+    "node_started",
+    "text_chunk",
+    "node_finished",
+    "workflow_finished",
+    "tts_message",
+    "tts_message_end",
+    "ping",
+]
+
+# Node types
+NodeType = Literal[
+    "start",
+    "end",
+    "llm",
+    "code",
+    "template",
+    "knowledge_retrieval",
+    "question_classifier",
+    "if_else",
+    "variable_assigner",
+    "parameter_extractor",
+]
+
+# Icon types
+IconType = Literal["emoji", "image"]
+
+# App mode types
+AppMode = Literal["workflow"]
+
+# Log status types
+LogStatus = Literal["succeeded", "failed", "stopped"]
+
+# Created by role types
+CreatedByRole = Literal["end_user", "account"]
+
+# Created from types
+CreatedFrom = Literal["service-api", "web-app"]

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

@@ -1 +0,0 @@
-from .workflow import *  # noqa 403

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

@@ -5,25 +5,33 @@ 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.get_workflow_log_request import GetWorkflowLogRequest
-from ..model.get_workflow_log_response import GetWorkflowLogResponse
-from ..model.get_workflow_result_request import GetWorkflowResultRequest
-from ..model.get_workflow_result_response import GetWorkflowResultResponse
+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:
     def __init__(self, config: Config) -> None:
-        self.config: Config = config
+        self.config = config
 
     @overload
     def run(
         self,
         request: RunWorkflowRequest,
-        option: RequestOption | None,
+        request_option: RequestOption,
         stream: Literal[True],
     ) -> Generator[bytes, None, None]: ...
 
@@ -31,29 +39,25 @@ class Workflow:
     def run(
         self,
         request: RunWorkflowRequest,
-        option: RequestOption | None,
-        stream: Literal[False],
+        request_option: RequestOption,
+        stream: Literal[False] = False,
     ) -> RunWorkflowResponse: ...
 
-    @overload
-    def run(self, request: RunWorkflowRequest, option: RequestOption | None) -> RunWorkflowResponse: ...
-
     def run(
         self,
         request: RunWorkflowRequest,
-        option: RequestOption | None = None,
+        request_option: RequestOption,
         stream: bool = False,
-    ):
+    ) -> RunWorkflowResponse | Generator[bytes, None, None]:
         if stream:
-            return Transport.execute(self.config, request, option=option, stream=True)
-        else:
-            return Transport.execute(self.config, request, unmarshal_as=RunWorkflowResponse, option=option)
+            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(
         self,
         request: RunWorkflowRequest,
-        option: RequestOption | None,
+        request_option: RequestOption,
         stream: Literal[True],
     ) -> AsyncGenerator[bytes, None]: ...
 
@@ -61,42 +65,68 @@ class Workflow:
     async def arun(
         self,
         request: RunWorkflowRequest,
-        option: RequestOption | None,
-        stream: Literal[False],
+        request_option: RequestOption,
+        stream: Literal[False] = False,
     ) -> RunWorkflowResponse: ...
 
-    @overload
-    async def arun(self, request: RunWorkflowRequest, option: RequestOption | None) -> RunWorkflowResponse: ...
-
     async def arun(
         self,
         request: RunWorkflowRequest,
-        option: RequestOption | None = None,
+        request_option: RequestOption,
         stream: bool = False,
-    ):
+    ) -> RunWorkflowResponse | AsyncGenerator[bytes, None]:
         if stream:
-            return await ATransport.aexecute(self.config, request, option=option, stream=True)
-        else:
-            return await ATransport.aexecute(self.config, request, unmarshal_as=RunWorkflowResponse, option=option)
+            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)
+
+    def detail(
+        self, request: GetWorkflowRunDetailRequest, request_option: RequestOption
+    ) -> GetWorkflowRunDetailResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetWorkflowRunDetailResponse, option=request_option)
+
+    async def adetail(
+        self, request: GetWorkflowRunDetailRequest, request_option: RequestOption
+    ) -> GetWorkflowRunDetailResponse:
+        return await ATransport.aexecute(
+            self.config, request, unmarshal_as=GetWorkflowRunDetailResponse, option=request_option
+        )
+
+    def stop(self, request: StopWorkflowRequest, request_option: RequestOption) -> StopWorkflowResponse:
+        return Transport.execute(self.config, request, unmarshal_as=StopWorkflowResponse, option=request_option)
+
+    async def astop(self, request: StopWorkflowRequest, request_option: RequestOption) -> StopWorkflowResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=StopWorkflowResponse, 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 aupload(self, request: UploadFileRequest, request_option: RequestOption) -> UploadFileResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=UploadFileResponse, option=request_option)
+
+    def logs(self, request: GetWorkflowLogsRequest, request_option: RequestOption) -> GetWorkflowLogsResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetWorkflowLogsResponse, option=request_option)
+
+    async def alogs(self, request: GetWorkflowLogsRequest, request_option: RequestOption) -> GetWorkflowLogsResponse:
+        return await ATransport.aexecute(
+            self.config, request, unmarshal_as=GetWorkflowLogsResponse, option=request_option
+        )
 
-    def stop(self, request: StopWorkflowRequest, option: RequestOption | None = None) -> StopWorkflowResponse:
-        return Transport.execute(self.config, request, unmarshal_as=StopWorkflowResponse, option=option)
+    def info(self, request: GetInfoRequest, request_option: RequestOption) -> GetInfoResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetInfoResponse, option=request_option)
 
-    async def astop(self, request: StopWorkflowRequest, option: RequestOption | None = None) -> StopWorkflowResponse:
-        return await ATransport.aexecute(self.config, request, unmarshal_as=StopWorkflowResponse, option=option)
+    async def ainfo(self, request: GetInfoRequest, request_option: RequestOption) -> GetInfoResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=GetInfoResponse, option=request_option)
 
-    def result(
-        self, request: GetWorkflowResultRequest, option: RequestOption | None = None
-    ) -> GetWorkflowResultResponse:
-        return Transport.execute(self.config, request, unmarshal_as=GetWorkflowResultResponse, option=option)
+    def parameters(self, request: GetParametersRequest, request_option: RequestOption) -> GetParametersResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetParametersResponse, option=request_option)
 
-    async def aresult(
-        self, request: GetWorkflowResultRequest, option: RequestOption | None = None
-    ) -> GetWorkflowResultResponse:
-        return await ATransport.aexecute(self.config, request, unmarshal_as=GetWorkflowResultResponse, option=option)
+    async def aparameters(self, request: GetParametersRequest, request_option: RequestOption) -> GetParametersResponse:
+        return await ATransport.aexecute(
+            self.config, request, unmarshal_as=GetParametersResponse, option=request_option
+        )
 
-    def log(self, request: GetWorkflowLogRequest, option: RequestOption | None = None) -> GetWorkflowLogResponse:
-        return Transport.execute(self.config, request, unmarshal_as=GetWorkflowLogResponse, option=option)
+    def site(self, request: GetSiteRequest, request_option: RequestOption) -> GetSiteResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetSiteResponse, option=request_option)
 
-    async def alog(self, request: GetWorkflowLogRequest, option: RequestOption | None = None) -> GetWorkflowLogResponse:
-        return await ATransport.aexecute(self.config, request, unmarshal_as=GetWorkflowLogResponse, option=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,8 +1,8 @@
 from dify_oapi.core.model.config import Config
 
-from .resource import Workflow
+from .resource.workflow import Workflow
 
 
 class V1:
     def __init__(self, config: Config):
-        self.workflow: Workflow = Workflow(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.2.0.dist-info → dify_oapi2-0.4.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: dify-oapi2
-Version: 0.2.0
+Version: 0.4.0
 Summary: A package for interacting with the Dify Service-API
 License: MIT
 Keywords: dify,nlp,ai,language-processing
 Author: Oscaner Miao
-Author-email: oscaner1997@163.com
+Author-email: oscaner1997@gmail.com
 Requires-Python: >=3.10
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -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