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

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

@@ -1,24 +1,9 @@
 from __future__ import annotations
 
-from pydantic import BaseModel
-
 from dify_oapi.core.model.base_response import BaseResponse
 
-
-class RunWorkflowResponse(BaseResponse):
-    workflow_run_id: str | None = None
-    task_id: str | None = None
-    data: RunWorkflowResponseData | None = None
+from .workflow_run_info import WorkflowRunInfo
 
 
-class RunWorkflowResponseData(BaseModel):
-    id: str | None = None
-    workflow_id: str | None = None
-    status: str | None = None
-    outputs: dict | None = None
-    error: str | None = None
-    elapsed_time: float | None = None
-    total_tokens: int | None = None
-    total_steps: int | None = None
-    created_at: int | None = None
-    finished_at: int | None = None
+class RunWorkflowResponse(WorkflowRunInfo, BaseResponse):
+    pass

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

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .workflow_types import IconType
+
+
+class SiteInfo(BaseModel):
+    title: str | None = None
+    icon_type: IconType | None = None
+    icon: str | None = None
+    icon_background: str | None = None
+    icon_url: str | None = None
+    description: str | None = None
+    copyright: str | None = None
+    privacy_policy: str | None = None
+    custom_disclaimer: str | None = None
+    default_language: str | None = None
+    show_workflow_steps: bool | None = None
+
+    @staticmethod
+    def builder() -> SiteInfoBuilder:
+        return SiteInfoBuilder()
+
+
+class SiteInfoBuilder:
+    def __init__(self):
+        self._site_info = SiteInfo()
+
+    def build(self) -> SiteInfo:
+        return self._site_info
+
+    def title(self, title: str) -> SiteInfoBuilder:
+        self._site_info.title = title
+        return self
+
+    def icon_type(self, icon_type: IconType) -> SiteInfoBuilder:
+        self._site_info.icon_type = icon_type
+        return self
+
+    def icon(self, icon: str) -> SiteInfoBuilder:
+        self._site_info.icon = icon
+        return self
+
+    def icon_background(self, icon_background: str) -> SiteInfoBuilder:
+        self._site_info.icon_background = icon_background
+        return self
+
+    def icon_url(self, icon_url: str) -> SiteInfoBuilder:
+        self._site_info.icon_url = icon_url
+        return self
+
+    def description(self, description: str) -> SiteInfoBuilder:
+        self._site_info.description = description
+        return self
+
+    def copyright(self, copyright: str) -> SiteInfoBuilder:
+        self._site_info.copyright = copyright
+        return self
+
+    def privacy_policy(self, privacy_policy: str) -> SiteInfoBuilder:
+        self._site_info.privacy_policy = privacy_policy
+        return self
+
+    def custom_disclaimer(self, custom_disclaimer: str) -> SiteInfoBuilder:
+        self._site_info.custom_disclaimer = custom_disclaimer
+        return self
+
+    def default_language(self, default_language: str) -> SiteInfoBuilder:
+        self._site_info.default_language = default_language
+        return self
+
+    def show_workflow_steps(self, show_workflow_steps: bool) -> SiteInfoBuilder:
+        self._site_info.show_workflow_steps = show_workflow_steps
+        return self

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

@@ -18,21 +18,21 @@ class StopWorkflowRequest(BaseRequest):
 
 
 class StopWorkflowRequestBuilder:
-    def __init__(self) -> None:
-        stop_Workflow_request = StopWorkflowRequest()
-        stop_Workflow_request.http_method = HttpMethod.POST
-        stop_Workflow_request.uri = "/v1/workflows/tasks/:task_id/stop"
-        self._stop_workflow_request: StopWorkflowRequest = stop_Workflow_request
+    def __init__(self):
+        stop_workflow_request = StopWorkflowRequest()
+        stop_workflow_request.http_method = HttpMethod.POST
+        stop_workflow_request.uri = "/v1/workflows/tasks/:task_id/stop"
+        self._stop_workflow_request = stop_workflow_request
+
+    def build(self) -> StopWorkflowRequest:
+        return self._stop_workflow_request
 
     def task_id(self, task_id: str) -> StopWorkflowRequestBuilder:
         self._stop_workflow_request.task_id = task_id
-        self._stop_workflow_request.paths["task_id"] = str(task_id)
+        self._stop_workflow_request.paths["task_id"] = task_id
         return self
 
     def request_body(self, request_body: StopWorkflowRequestBody) -> StopWorkflowRequestBuilder:
         self._stop_workflow_request.request_body = request_body
         self._stop_workflow_request.body = request_body.model_dump(exclude_none=True, mode="json")
         return self
-
-    def build(self) -> StopWorkflowRequest:
-        return self._stop_workflow_request

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

@@ -15,9 +15,9 @@ class StopWorkflowRequestBodyBuilder:
     def __init__(self):
         self._stop_workflow_request_body = StopWorkflowRequestBody()
 
+    def build(self) -> StopWorkflowRequestBody:
+        return self._stop_workflow_request_body
+
     def user(self, user: str) -> StopWorkflowRequestBodyBuilder:
         self._stop_workflow_request_body.user = user
         return self
-
-    def build(self) -> StopWorkflowRequestBody:
-        return self._stop_workflow_request_body

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

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dify_oapi.core.model.base_response import BaseResponse
 
 

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

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class SystemParameters(BaseModel):
+    file_size_limit: int | None = None
+    image_file_size_limit: int | None = None
+    audio_file_size_limit: int | None = None
+    video_file_size_limit: int | None = None
+
+    @staticmethod
+    def builder() -> SystemParametersBuilder:
+        return SystemParametersBuilder()
+
+
+class SystemParametersBuilder:
+    def __init__(self):
+        self._system_parameters = SystemParameters()
+
+    def build(self) -> SystemParameters:
+        return self._system_parameters
+
+    def file_size_limit(self, file_size_limit: int) -> SystemParametersBuilder:
+        self._system_parameters.file_size_limit = file_size_limit
+        return self
+
+    def image_file_size_limit(self, image_file_size_limit: int) -> SystemParametersBuilder:
+        self._system_parameters.image_file_size_limit = image_file_size_limit
+        return self
+
+    def audio_file_size_limit(self, audio_file_size_limit: int) -> SystemParametersBuilder:
+        self._system_parameters.audio_file_size_limit = audio_file_size_limit
+        return self
+
+    def video_file_size_limit(self, video_file_size_limit: int) -> SystemParametersBuilder:
+        self._system_parameters.video_file_size_limit = video_file_size_limit
+        return self

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

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from io import BytesIO
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+from .upload_file_request_body import UploadFileRequestBody
+
+
+class UploadFileRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+        self.request_body: UploadFileRequestBody | None = None
+        self.file: BytesIO | None = None
+
+    @staticmethod
+    def builder() -> UploadFileRequestBuilder:
+        return UploadFileRequestBuilder()
+
+
+class UploadFileRequestBuilder:
+    def __init__(self):
+        upload_file_request = UploadFileRequest()
+        upload_file_request.http_method = HttpMethod.POST
+        upload_file_request.uri = "/v1/files/upload"
+        self._upload_file_request = upload_file_request
+
+    def build(self) -> UploadFileRequest:
+        return self._upload_file_request
+
+    def file(self, file: BytesIO, file_name: str | None = None) -> UploadFileRequestBuilder:
+        self._upload_file_request.file = file
+        file_name = file_name or "upload"
+        self._upload_file_request.files = {"file": (file_name, file)}
+        return self
+
+    def request_body(self, request_body: UploadFileRequestBody) -> UploadFileRequestBuilder:
+        self._upload_file_request.request_body = request_body
+        if request_body.user:
+            self._upload_file_request.body = {"user": request_body.user}
+        return self

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

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class UploadFileRequestBody(BaseModel):
+    user: str | None = None
+
+    @staticmethod
+    def builder() -> UploadFileRequestBodyBuilder:
+        return UploadFileRequestBodyBuilder()
+
+
+class UploadFileRequestBodyBuilder:
+    def __init__(self):
+        self._upload_file_request_body = UploadFileRequestBody()
+
+    def build(self) -> UploadFileRequestBody:
+        return self._upload_file_request_body
+
+    def user(self, user: str) -> UploadFileRequestBodyBuilder:
+        self._upload_file_request_body.user = user
+        return self

dify_oapi/api/{knowledge_base/v1/model/dataset/delete_response.py → workflow/v1/model/upload_file_response.py}

@@ -2,8 +2,8 @@ from __future__ import annotations
 
 from dify_oapi.core.model.base_response import BaseResponse
 
+from .file_upload_info import FileUploadInfo
 
-class DeleteResponse(BaseResponse):
-    """Response model for delete dataset API (204 No Content)"""
 
+class UploadFileResponse(FileUploadInfo, BaseResponse):
     pass

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

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class UserInputForm(BaseModel):
+    label: str | None = None
+    variable: str | None = None
+    required: bool | None = None
+    default: str | None = None
+    options: list[str] | None = None
+
+    @staticmethod
+    def builder() -> UserInputFormBuilder:
+        return UserInputFormBuilder()
+
+
+class UserInputFormBuilder:
+    def __init__(self):
+        self._user_input_form = UserInputForm()
+
+    def build(self) -> UserInputForm:
+        return self._user_input_form
+
+    def label(self, label: str) -> UserInputFormBuilder:
+        self._user_input_form.label = label
+        return self
+
+    def variable(self, variable: str) -> UserInputFormBuilder:
+        self._user_input_form.variable = variable
+        return self
+
+    def required(self, required: bool) -> UserInputFormBuilder:
+        self._user_input_form.required = required
+        return self
+
+    def default(self, default: str) -> UserInputFormBuilder:
+        self._user_input_form.default = default
+        return self
+
+    def options(self, options: list[str]) -> UserInputFormBuilder:
+        self._user_input_form.options = options
+        return self

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

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .workflow_types import FileType, TransferMethod
+
+
+class WorkflowFileInfo(BaseModel):
+    type: FileType | None = None
+    transfer_method: TransferMethod | None = None
+    url: str | None = None
+    upload_file_id: str | None = None
+
+    @staticmethod
+    def builder() -> WorkflowFileInfoBuilder:
+        return WorkflowFileInfoBuilder()
+
+
+class WorkflowFileInfoBuilder:
+    def __init__(self):
+        self._workflow_file_info = WorkflowFileInfo()
+
+    def build(self) -> WorkflowFileInfo:
+        return self._workflow_file_info
+
+    def type(self, type: FileType) -> WorkflowFileInfoBuilder:
+        self._workflow_file_info.type = type
+        return self
+
+    def transfer_method(self, transfer_method: TransferMethod) -> WorkflowFileInfoBuilder:
+        self._workflow_file_info.transfer_method = transfer_method
+        return self
+
+    def url(self, url: str) -> WorkflowFileInfoBuilder:
+        self._workflow_file_info.url = url
+        return self
+
+    def upload_file_id(self, upload_file_id: str) -> WorkflowFileInfoBuilder:
+        self._workflow_file_info.upload_file_id = upload_file_id
+        return self

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

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from typing import Union
+
+from pydantic import BaseModel
+
+from .workflow_file_info import WorkflowFileInfo
+
+# Define specific types for workflow input values
+WorkflowInputValue = Union[
+    str,  # Text values
+    int,  # Integer values
+    float,  # Float values
+    bool,  # Boolean values
+    list[WorkflowFileInfo],  # File list type variables
+    list[str],  # String arrays
+    dict[str, Union[str, int, float, bool]],  # Object values
+]
+
+
+class WorkflowInputs(BaseModel):
+    # Dynamic inputs based on workflow configuration
+    # Can contain any key-value pairs defined by the workflow
+    inputs: dict[str, WorkflowInputValue] | None = None
+
+    @staticmethod
+    def builder() -> WorkflowInputsBuilder:
+        return WorkflowInputsBuilder()
+
+    def add_input(self, key: str, value: WorkflowInputValue) -> None:
+        if self.inputs is None:
+            self.inputs = {}
+        self.inputs[key] = value
+
+    def get_input(self, key: str) -> WorkflowInputValue | None:
+        if self.inputs is None:
+            return None
+        return self.inputs.get(key)
+
+
+class WorkflowInputsBuilder:
+    def __init__(self):
+        self._workflow_inputs = WorkflowInputs()
+
+    def build(self) -> WorkflowInputs:
+        return self._workflow_inputs
+
+    def inputs(self, inputs: dict[str, WorkflowInputValue]) -> WorkflowInputsBuilder:
+        self._workflow_inputs.inputs = inputs
+        return self
+
+    def add_input(self, key: str, value: WorkflowInputValue) -> WorkflowInputsBuilder:
+        if self._workflow_inputs.inputs is None:
+            self._workflow_inputs.inputs = {}
+        self._workflow_inputs.inputs[key] = value
+        return self

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/workflow_run_data.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+from .workflow_types import WorkflowStatus
+
+
+class WorkflowRunData(BaseModel):
+    id: str | None = None
+    workflow_id: str | None = None
+    status: WorkflowStatus | None = None
+    outputs: dict[str, Any] | None = None
+    error: str | None = None
+    elapsed_time: float | None = None
+    total_tokens: int | None = None
+    total_steps: int | None = None
+    created_at: int | None = None
+    finished_at: int | None = None
+
+    @staticmethod
+    def builder() -> WorkflowRunDataBuilder:
+        return WorkflowRunDataBuilder()
+
+
+class WorkflowRunDataBuilder:
+    def __init__(self):
+        self._workflow_run_data = WorkflowRunData()
+
+    def build(self) -> WorkflowRunData:
+        return self._workflow_run_data
+
+    def id(self, id: str) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.id = id
+        return self
+
+    def workflow_id(self, workflow_id: str) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.workflow_id = workflow_id
+        return self
+
+    def status(self, status: WorkflowStatus) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.status = status
+        return self
+
+    def outputs(self, outputs: dict[str, Any]) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.outputs = outputs
+        return self
+
+    def error(self, error: str) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.error = error
+        return self
+
+    def elapsed_time(self, elapsed_time: float) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.elapsed_time = elapsed_time
+        return self
+
+    def total_tokens(self, total_tokens: int) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.total_tokens = total_tokens
+        return self
+
+    def total_steps(self, total_steps: int) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.total_steps = total_steps
+        return self
+
+    def created_at(self, created_at: int) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.created_at = created_at
+        return self
+
+    def finished_at(self, finished_at: int) -> WorkflowRunDataBuilder:
+        self._workflow_run_data.finished_at = finished_at
+        return self

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

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .workflow_run_data import WorkflowRunData
+
+
+class WorkflowRunInfo(BaseModel):
+    workflow_run_id: str | None = None
+    task_id: str | None = None
+    data: WorkflowRunData | None = None
+
+    @staticmethod
+    def builder() -> WorkflowRunInfoBuilder:
+        return WorkflowRunInfoBuilder()
+
+
+class WorkflowRunInfoBuilder:
+    def __init__(self):
+        self._workflow_run_info = WorkflowRunInfo()
+
+    def build(self) -> WorkflowRunInfo:
+        return self._workflow_run_info
+
+    def workflow_run_id(self, workflow_run_id: str) -> WorkflowRunInfoBuilder:
+        self._workflow_run_info.workflow_run_id = workflow_run_id
+        return self
+
+    def task_id(self, task_id: str) -> WorkflowRunInfoBuilder:
+        self._workflow_run_info.task_id = task_id
+        return self
+
+    def data(self, data: WorkflowRunData) -> WorkflowRunInfoBuilder:
+        self._workflow_run_info.data = data
+        return self

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

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .workflow_types import LogStatus
+
+
+class WorkflowRunLogInfo(BaseModel):
+    id: str | None = None
+    version: str | None = None
+    status: LogStatus | None = None
+    error: str | None = None
+    elapsed_time: float | None = None
+    total_tokens: int | None = None
+    total_steps: int | None = None
+    created_at: int | None = None
+    finished_at: int | None = None
+
+    @staticmethod
+    def builder() -> WorkflowRunLogInfoBuilder:
+        return WorkflowRunLogInfoBuilder()
+
+
+class WorkflowRunLogInfoBuilder:
+    def __init__(self):
+        self._workflow_run_log_info = WorkflowRunLogInfo()
+
+    def build(self) -> WorkflowRunLogInfo:
+        return self._workflow_run_log_info
+
+    def id(self, id: str) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.id = id
+        return self
+
+    def version(self, version: str) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.version = version
+        return self
+
+    def status(self, status: LogStatus) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.status = status
+        return self
+
+    def error(self, error: str) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.error = error
+        return self
+
+    def elapsed_time(self, elapsed_time: float) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.elapsed_time = elapsed_time
+        return self
+
+    def total_tokens(self, total_tokens: int) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.total_tokens = total_tokens
+        return self
+
+    def total_steps(self, total_steps: int) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.total_steps = total_steps
+        return self
+
+    def created_at(self, created_at: int) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.created_at = created_at
+        return self
+
+    def finished_at(self, finished_at: int) -> WorkflowRunLogInfoBuilder:
+        self._workflow_run_log_info.finished_at = finished_at
+        return self