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

dify_oapi/api/completion/v1/resource/feedback.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+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.feedback.get_feedbacks_request import GetFeedbacksRequest
+from ..model.feedback.get_feedbacks_response import GetFeedbacksResponse
+from ..model.feedback.message_feedback_request import MessageFeedbackRequest
+from ..model.feedback.message_feedback_response import MessageFeedbackResponse
+
+
+class Feedback:
+    def __init__(self, config: Config) -> None:
+        self.config: Config = config
+
+    def message_feedback(
+        self, request: MessageFeedbackRequest, request_option: RequestOption
+    ) -> MessageFeedbackResponse:
+        return Transport.execute(self.config, request, unmarshal_as=MessageFeedbackResponse, option=request_option)
+
+    async def amessage_feedback(
+        self, request: MessageFeedbackRequest, request_option: RequestOption
+    ) -> MessageFeedbackResponse:
+        return await ATransport.aexecute(
+            self.config, request, unmarshal_as=MessageFeedbackResponse, option=request_option
+        )
+
+    def get_feedbacks(self, request: GetFeedbacksRequest, request_option: RequestOption) -> GetFeedbacksResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetFeedbacksResponse, option=request_option)
+
+    async def aget_feedbacks(self, request: GetFeedbacksRequest, request_option: RequestOption) -> GetFeedbacksResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=GetFeedbacksResponse, option=request_option)

dify_oapi/api/completion/v1/resource/file.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+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.file.upload_file_request import UploadFileRequest
+from ..model.file.upload_file_response import UploadFileResponse
+
+
+class File:
+    def __init__(self, config: Config) -> None:
+        self.config: Config = config
+
+    def upload_file(self, request: UploadFileRequest, request_option: RequestOption) -> UploadFileResponse:
+        return Transport.execute(self.config, request, unmarshal_as=UploadFileResponse, option=request_option)
+
+    async def aupload_file(self, request: UploadFileRequest, request_option: RequestOption) -> UploadFileResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=UploadFileResponse, option=request_option)

dify_oapi/api/completion/v1/resource/info.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+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.info.get_info_request import GetInfoRequest
+from ..model.info.get_info_response import GetInfoResponse
+from ..model.info.get_parameters_request import GetParametersRequest
+from ..model.info.get_parameters_response import GetParametersResponse
+from ..model.info.get_site_request import GetSiteRequest
+from ..model.info.get_site_response import GetSiteResponse
+
+
+class Info:
+    def __init__(self, config: Config) -> None:
+        self.config: Config = config
+
+    def get_info(self, request: GetInfoRequest, request_option: RequestOption) -> GetInfoResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetInfoResponse, option=request_option)
+
+    async def aget_info(self, request: GetInfoRequest, request_option: RequestOption) -> GetInfoResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=GetInfoResponse, option=request_option)
+
+    def get_parameters(self, request: GetParametersRequest, request_option: RequestOption) -> GetParametersResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetParametersResponse, option=request_option)
+
+    async def aget_parameters(
+        self, request: GetParametersRequest, request_option: RequestOption
+    ) -> GetParametersResponse:
+        return await ATransport.aexecute(
+            self.config, request, unmarshal_as=GetParametersResponse, option=request_option
+        )
+
+    def get_site(self, request: GetSiteRequest, request_option: RequestOption) -> GetSiteResponse:
+        return Transport.execute(self.config, request, unmarshal_as=GetSiteResponse, option=request_option)
+
+    async def aget_site(self, request: GetSiteRequest, request_option: RequestOption) -> GetSiteResponse:
+        return await ATransport.aexecute(self.config, request, unmarshal_as=GetSiteResponse, option=request_option)

dify_oapi/api/completion/v1/version.py

@@ -1,8 +1,18 @@
 from dify_oapi.core.model.config import Config
 
-from .resource import Completion
+from .resource.annotation import Annotation
+from .resource.audio import Audio
+from .resource.completion import Completion
+from .resource.feedback import Feedback
+from .resource.file import File
+from .resource.info import Info
 
 
 class V1:
     def __init__(self, config: Config):
         self.completion: Completion = Completion(config)
+        self.file: File = File(config)
+        self.feedback: Feedback = Feedback(config)
+        self.audio: Audio = Audio(config)
+        self.info: Info = Info(config)
+        self.annotation: Annotation = Annotation(config)

dify_oapi/api/knowledge_base/v1/model/dataset/create_request_body.py

@@ -1,16 +1,15 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from pydantic import BaseModel
 
+from .dataset_types import IndexingTechnique
 from .retrieval_model import RetrievalModel
 
 
 class CreateRequestBody(BaseModel):
     name: str | None = None
     description: str | None = None
-    indexing_technique: str | None = None
+    indexing_technique: IndexingTechnique | None = None
     permission: str | None = None
     provider: str | None = None
     external_knowledge_api_id: str | None = None
@@ -40,7 +39,7 @@ class CreateRequestBodyBuilder:
         self._create_request_body.description = description
         return self
 
-    def indexing_technique(self, indexing_technique: Literal["high_quality", "economy"]) -> CreateRequestBodyBuilder:
+    def indexing_technique(self, indexing_technique: IndexingTechnique) -> CreateRequestBodyBuilder:
         self._create_request_body.indexing_technique = indexing_technique
         return self
 

dify_oapi/api/knowledge_base/v1/model/dataset/dataset_types.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from typing import Literal
+
+# Indexing technique types
+IndexingTechnique = Literal["high_quality", "economy"]
+
+# Search method types
+SearchMethod = Literal["keyword_search", "semantic_search", "full_text_search", "hybrid_search"]
+
+# Reranking model types
+RerankingModelType = Literal["rerank-model"]
+
+# Processing rule mode types
+ProcessingRuleMode = Literal["automatic", "custom"]
+
+# Data source types
+DataSourceType = Literal["upload_file", "notion_import", "website_crawl"]
+
+# Document status types
+DocumentStatus = Literal["indexing", "completed", "error", "paused"]
+
+# Metadata field types
+MetadataFieldType = Literal["text", "number", "select"]
+
+# Tag types
+TagType = Literal["knowledge", "custom"]
+
+# Built-in metadata actions
+BuiltinMetadataAction = Literal["enable", "disable"]
+
+# Filter operator types
+FilterOperator = Literal["contains", "not_contains", "is", "is_not", "is_empty", "is_not_empty"]
+
+# Reranking enable types
+RerankingEnable = Literal[True, False]

dify_oapi/api/knowledge_base/v1/model/dataset/retrieval_model.py

@@ -1,9 +1,8 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from pydantic import BaseModel
 
+from .dataset_types import SearchMethod
 from .metadata_filtering_conditions import MetadataFilteringConditions
 from .reranking_model import RerankingModel
 
@@ -84,7 +83,7 @@ class WeightsBuilder:
 
 
 class RetrievalModel(BaseModel):
-    search_method: str | None = None
+    search_method: SearchMethod | None = None
     reranking_enable: bool | None = None
     reranking_mode: str | None = None
     reranking_model: RerankingModel | None = None
@@ -106,9 +105,7 @@ class RetrievalModelBuilder:
     def build(self) -> RetrievalModel:
         return self._retrieval_model
 
-    def search_method(
-        self, search_method: Literal["keyword_search", "semantic_search", "full_text_search", "hybrid_search"]
-    ) -> RetrievalModelBuilder:
+    def search_method(self, search_method: SearchMethod) -> RetrievalModelBuilder:
         self._retrieval_model.search_method = search_method
         return self
 

dify_oapi/api/knowledge_base/v1/model/document/create_by_text_request_body.py

@@ -1,9 +1,8 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from pydantic import BaseModel
 
+from .document_types import DocumentForm, DocumentLanguage, IndexingTechnique
 from .process_rule import ProcessRule
 from .retrieval_model import RetrievalModel
 
@@ -13,9 +12,9 @@ class CreateByTextRequestBody(BaseModel):
 
     name: str | None = None
     text: str | None = None
-    indexing_technique: str | None = None
-    doc_form: str | None = None
-    doc_language: str | None = None
+    indexing_technique: IndexingTechnique | None = None
+    doc_form: DocumentForm | None = None
+    doc_language: DocumentLanguage | None = None
     process_rule: ProcessRule | None = None
     retrieval_model: RetrievalModel | None = None
     embedding_model: str | None = None
@@ -47,19 +46,15 @@ class CreateByTextRequestBodyBuilder:
         self._create_by_text_request_body.text = text
         return self
 
-    def indexing_technique(
-        self, indexing_technique: Literal["high_quality", "economy"]
-    ) -> CreateByTextRequestBodyBuilder:
+    def indexing_technique(self, indexing_technique: IndexingTechnique) -> CreateByTextRequestBodyBuilder:
         self._create_by_text_request_body.indexing_technique = indexing_technique
         return self
 
-    def doc_form(
-        self, doc_form: Literal["text_model", "hierarchical_model", "qa_model"]
-    ) -> CreateByTextRequestBodyBuilder:
+    def doc_form(self, doc_form: DocumentForm) -> CreateByTextRequestBodyBuilder:
         self._create_by_text_request_body.doc_form = doc_form
         return self
 
-    def doc_language(self, doc_language: str) -> CreateByTextRequestBodyBuilder:
+    def doc_language(self, doc_language: DocumentLanguage) -> CreateByTextRequestBodyBuilder:
         self._create_by_text_request_body.doc_language = doc_language
         return self
 

dify_oapi/api/knowledge_base/v1/model/document/document_types.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from typing import Literal
+
+# Indexing technique types
+IndexingTechnique = Literal["high_quality", "economy"]
+
+# Document form types
+DocumentForm = Literal["text_model", "hierarchical_model", "qa_model"]
+
+# Document language types
+DocumentLanguage = Literal["English", "Chinese", "Japanese", "Korean"]
+
+# Processing rule mode types
+ProcessingRuleMode = Literal["automatic", "custom"]
+
+# Segmentation separator types
+Separator = Literal["\\n\\n", "\\n", ".", "!", "?", ";"]
+
+# Pre-processing rule types
+PreProcessingRuleType = Literal["remove_extra_spaces", "remove_urls_emails"]
+
+# Data source types
+DataSourceType = Literal["upload_file", "notion_import", "website_crawl"]
+
+# Document indexing status types
+IndexingStatus = Literal["waiting", "parsing", "cleaning", "splitting", "indexing", "completed", "error", "paused"]
+
+# Document status action types
+StatusAction = Literal["enable", "disable", "archive"]
+
+# Upload file status types
+UploadFileStatus = Literal["success", "processing", "error"]
+
+# Document enabled status
+DocumentEnabled = Literal[True, False]

dify_oapi/api/knowledge_base/v1/model/metadata/metadata_types.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from typing import Literal
+
+# Metadata field types
+MetadataFieldType = Literal["text", "number", "select"]
+
+# Built-in metadata actions
+BuiltinMetadataAction = Literal["enable", "disable"]
+
+# Metadata status types
+MetadataStatus = Literal["active", "inactive"]
+
+# Metadata scope types
+MetadataScope = Literal["document", "segment"]

dify_oapi/api/knowledge_base/v1/model/segment/segment_types.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import Literal
+
+# Segment status types
+SegmentStatus = Literal["waiting", "indexing", "completed", "error", "paused"]
+
+# Segment enabled status types
+SegmentEnabledStatus = Literal["enabled", "disabled"]
+
+# Child chunk status types
+ChildChunkStatus = Literal["waiting", "indexing", "completed", "error"]
+
+# Segment search status types
+SearchStatus = Literal["all", "enabled", "disabled"]
+
+# Sort order types
+SortOrder = Literal["created_at", "position", "word_count", "hit_count"]
+
+# Sort direction types
+SortDirection = Literal["asc", "desc"]
+
+# Segment enabled boolean
+SegmentEnabled = Literal[True, False]

dify_oapi/api/knowledge_base/v1/model/tag/tag_types.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from typing import Literal
+
+# Tag types
+TagType = Literal["knowledge", "custom"]
+
+# Tag status types
+TagStatus = Literal["active", "inactive"]
+
+# Tag binding status types
+BindingStatus = Literal["bound", "unbound"]

dify_oapi/api/knowledge_base/v1/model/tag/update_response.py

@@ -11,9 +11,13 @@ class UpdateResponse(BaseResponse):
     binding_count: int | str | None = None
 
     def to_tag_info(self) -> TagInfo:
+        binding_count = None
+        if self.binding_count is not None:
+            binding_count = int(self.binding_count) if isinstance(self.binding_count, str) else self.binding_count
+
         return TagInfo(
             id=self.id or "",
             name=self.name or "",
             type=self.type or "",
-            binding_count=self.binding_count or 0,
+            binding_count=binding_count or 0,
         )

dify_oapi/api/workflow/v1/model/file/__init__.py

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

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_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_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_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_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_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_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_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_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_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