dify-oapi2 0.2.0__tar.gz → 0.3.0__tar.gz

{dify_oapi2-0.2.0 → dify_oapi2-0.3.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: dify-oapi2
-Version: 0.2.0
+Version: 0.3.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

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/file/__init__.py

@@ -0,0 +1 @@
+# File models for workflow API

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/file/file_info.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class FileInfo(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() -> FileInfoBuilder:
+        return FileInfoBuilder()
+
+
+class FileInfoBuilder:
+    def __init__(self):
+        self._file_info = FileInfo()
+
+    def build(self) -> FileInfo:
+        return self._file_info
+
+    def id(self, id: str) -> FileInfoBuilder:
+        self._file_info.id = id
+        return self
+
+    def name(self, name: str) -> FileInfoBuilder:
+        self._file_info.name = name
+        return self
+
+    def size(self, size: int) -> FileInfoBuilder:
+        self._file_info.size = size
+        return self
+
+    def extension(self, extension: str) -> FileInfoBuilder:
+        self._file_info.extension = extension
+        return self
+
+    def mime_type(self, mime_type: str) -> FileInfoBuilder:
+        self._file_info.mime_type = mime_type
+        return self
+
+    def created_by(self, created_by: str) -> FileInfoBuilder:
+        self._file_info.created_by = created_by
+        return self
+
+    def created_at(self, created_at: int) -> FileInfoBuilder:
+        self._file_info.created_at = created_at
+        return self

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/file/preview_file_request.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class PreviewFileRequest(BaseRequest):
+    def __init__(self) -> None:
+        super().__init__()
+        self.file_id: str | None = None
+
+    @staticmethod
+    def builder() -> PreviewFileRequestBuilder:
+        return PreviewFileRequestBuilder()
+
+
+class PreviewFileRequestBuilder:
+    def __init__(self):
+        preview_file_request = PreviewFileRequest()
+        preview_file_request.http_method = HttpMethod.GET
+        preview_file_request.uri = "/v1/files/:file_id/preview"
+        self._preview_file_request = preview_file_request
+
+    def build(self) -> PreviewFileRequest:
+        return self._preview_file_request
+
+    def file_id(self, file_id: str) -> PreviewFileRequestBuilder:
+        self._preview_file_request.file_id = file_id
+        self._preview_file_request.paths["file_id"] = file_id
+        return self
+
+    def as_attachment(self, as_attachment: bool) -> PreviewFileRequestBuilder:
+        self._preview_file_request.add_query("as_attachment", str(as_attachment).lower())
+        return self

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/file/preview_file_response.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+
+class PreviewFileResponse(BaseResponse):
+    content_type: str | None = None
+    content_length: int | None = None
+    content: bytes | None = None

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/file/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_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/file/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_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/file/upload_file_response.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .file_info import FileInfo
+
+
+class UploadFileResponse(FileInfo, BaseResponse):
+    pass

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/app_info.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from ..workflow.workflow_types import AppMode
+
+
+class AppInfo(BaseModel):
+    name: str | None = None
+    description: str | None = None
+    tags: list[str] | None = None
+    mode: AppMode | None = None
+    author_name: str | None = None
+
+    @staticmethod
+    def builder() -> AppInfoBuilder:
+        return AppInfoBuilder()
+
+
+class AppInfoBuilder:
+    def __init__(self):
+        self._app_info = AppInfo()
+
+    def build(self) -> AppInfo:
+        return self._app_info
+
+    def name(self, name: str) -> AppInfoBuilder:
+        self._app_info.name = name
+        return self
+
+    def description(self, description: str) -> AppInfoBuilder:
+        self._app_info.description = description
+        return self
+
+    def tags(self, tags: list[str]) -> AppInfoBuilder:
+        self._app_info.tags = tags
+        return self
+
+    def mode(self, mode: AppMode) -> AppInfoBuilder:
+        self._app_info.mode = mode
+        return self
+
+    def author_name(self, author_name: str) -> AppInfoBuilder:
+        self._app_info.author_name = author_name
+        return self

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/file_upload_config.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class FileUploadConfig(BaseModel):
+    document: dict[str, Any] | None = None
+    image: dict[str, Any] | None = None
+    audio: dict[str, Any] | None = None
+    video: dict[str, Any] | None = None
+    custom: dict[str, Any] | None = None
+
+    @staticmethod
+    def builder() -> FileUploadConfigBuilder:
+        return FileUploadConfigBuilder()
+
+
+class FileUploadConfigBuilder:
+    def __init__(self):
+        self._file_upload_config = FileUploadConfig()
+
+    def build(self) -> FileUploadConfig:
+        return self._file_upload_config
+
+    def document(self, document: dict[str, Any]) -> FileUploadConfigBuilder:
+        self._file_upload_config.document = document
+        return self
+
+    def image(self, image: dict[str, Any]) -> FileUploadConfigBuilder:
+        self._file_upload_config.image = image
+        return self
+
+    def audio(self, audio: dict[str, Any]) -> FileUploadConfigBuilder:
+        self._file_upload_config.audio = audio
+        return self
+
+    def video(self, video: dict[str, Any]) -> FileUploadConfigBuilder:
+        self._file_upload_config.video = video
+        return self
+
+    def custom(self, custom: dict[str, Any]) -> FileUploadConfigBuilder:
+        self._file_upload_config.custom = custom
+        return self

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/get_info_request.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetInfoRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+
+    @staticmethod
+    def builder() -> GetInfoRequestBuilder:
+        return GetInfoRequestBuilder()
+
+
+class GetInfoRequestBuilder:
+    def __init__(self):
+        get_info_request = GetInfoRequest()
+        get_info_request.http_method = HttpMethod.GET
+        get_info_request.uri = "/v1/info"
+        self._get_info_request = get_info_request
+
+    def build(self) -> GetInfoRequest:
+        return self._get_info_request

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/get_info_response.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .app_info import AppInfo
+
+
+class GetInfoResponse(AppInfo, BaseResponse):
+    pass

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/get_parameters_request.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetParametersRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+
+    @staticmethod
+    def builder() -> GetParametersRequestBuilder:
+        return GetParametersRequestBuilder()
+
+
+class GetParametersRequestBuilder:
+    def __init__(self):
+        get_parameters_request = GetParametersRequest()
+        get_parameters_request.http_method = HttpMethod.GET
+        get_parameters_request.uri = "/v1/parameters"
+        self._get_parameters_request = get_parameters_request
+
+    def build(self) -> GetParametersRequest:
+        return self._get_parameters_request

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/get_parameters_response.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .parameters_info import ParametersInfo
+
+
+class GetParametersResponse(ParametersInfo, BaseResponse):
+    pass

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/get_site_request.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetSiteRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+
+    @staticmethod
+    def builder() -> GetSiteRequestBuilder:
+        return GetSiteRequestBuilder()
+
+
+class GetSiteRequestBuilder:
+    def __init__(self):
+        get_site_request = GetSiteRequest()
+        get_site_request.http_method = HttpMethod.GET
+        get_site_request.uri = "/v1/site"
+        self._get_site_request = get_site_request
+
+    def build(self) -> GetSiteRequest:
+        return self._get_site_request

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/get_site_response.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from dify_oapi.core.model.base_response import BaseResponse
+
+from .site_info import SiteInfo
+
+
+class GetSiteResponse(SiteInfo, BaseResponse):
+    pass

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/parameters_info.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from .file_upload_config import FileUploadConfig
+from .system_parameters import SystemParameters
+from .user_input_form import UserInputForm
+
+
+class ParametersInfo(BaseModel):
+    user_input_form: list[UserInputForm] | None = None
+    file_upload: FileUploadConfig | None = None
+    system_parameters: SystemParameters | None = None
+
+    @staticmethod
+    def builder() -> ParametersInfoBuilder:
+        return ParametersInfoBuilder()
+
+
+class ParametersInfoBuilder:
+    def __init__(self):
+        self._parameters_info = ParametersInfo()
+
+    def build(self) -> ParametersInfo:
+        return self._parameters_info
+
+    def user_input_form(self, user_input_form: list[UserInputForm]) -> ParametersInfoBuilder:
+        self._parameters_info.user_input_form = user_input_form
+        return self
+
+    def file_upload(self, file_upload: FileUploadConfig) -> ParametersInfoBuilder:
+        self._parameters_info.file_upload = file_upload
+        return self
+
+    def system_parameters(self, system_parameters: SystemParameters) -> ParametersInfoBuilder:
+        self._parameters_info.system_parameters = system_parameters
+        return self

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/site_info.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from ..workflow.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_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/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_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/info/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_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/log/end_user_info.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class EndUserInfo(BaseModel):
+    id: str | None = None
+    type: str | None = None
+    is_anonymous: bool | None = None
+    session_id: str | None = None
+
+    @staticmethod
+    def builder() -> EndUserInfoBuilder:
+        return EndUserInfoBuilder()
+
+
+class EndUserInfoBuilder:
+    def __init__(self):
+        self._end_user_info = EndUserInfo()
+
+    def build(self) -> EndUserInfo:
+        return self._end_user_info
+
+    def id(self, id: str) -> EndUserInfoBuilder:
+        self._end_user_info.id = id
+        return self
+
+    def type(self, type: str) -> EndUserInfoBuilder:
+        self._end_user_info.type = type
+        return self
+
+    def is_anonymous(self, is_anonymous: bool) -> EndUserInfoBuilder:
+        self._end_user_info.is_anonymous = is_anonymous
+        return self
+
+    def session_id(self, session_id: str) -> EndUserInfoBuilder:
+        self._end_user_info.session_id = session_id
+        return self

dify_oapi2-0.3.0/dify_oapi/api/workflow/v1/model/log/get_workflow_logs_request.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from dify_oapi.core.enum import HttpMethod
+from dify_oapi.core.model.base_request import BaseRequest
+
+
+class GetWorkflowLogsRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+
+    @staticmethod
+    def builder() -> GetWorkflowLogsRequestBuilder:
+        return GetWorkflowLogsRequestBuilder()
+
+
+class GetWorkflowLogsRequestBuilder:
+    def __init__(self):
+        get_workflow_logs_request = GetWorkflowLogsRequest()
+        get_workflow_logs_request.http_method = HttpMethod.GET
+        get_workflow_logs_request.uri = "/v1/workflows/logs"
+        self._get_workflow_logs_request = get_workflow_logs_request
+
+    def build(self) -> GetWorkflowLogsRequest:
+        return self._get_workflow_logs_request
+
+    def keyword(self, keyword: str) -> GetWorkflowLogsRequestBuilder:
+        self._get_workflow_logs_request.add_query("keyword", keyword)
+        return self
+
+    def status(self, status: str) -> GetWorkflowLogsRequestBuilder:
+        self._get_workflow_logs_request.add_query("status", status)
+        return self
+
+    def page(self, page: int) -> GetWorkflowLogsRequestBuilder:
+        self._get_workflow_logs_request.add_query("page", str(page))
+        return self
+
+    def limit(self, limit: int) -> GetWorkflowLogsRequestBuilder:
+        self._get_workflow_logs_request.add_query("limit", str(limit))
+        return self
+
+    def created_by_end_user_session_id(self, session_id: str) -> GetWorkflowLogsRequestBuilder:
+        self._get_workflow_logs_request.add_query("created_by_end_user_session_id", session_id)
+        return self
+
+    def created_by_account(self, account: str) -> GetWorkflowLogsRequestBuilder:
+        self._get_workflow_logs_request.add_query("created_by_account", account)
+        return self