dify-oapi2 0.1.1__py3-none-any.whl → 0.2.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/core/http/transport/_misc.py

@@ -48,8 +48,15 @@ def _merge_dicts(*dicts: dict | None) -> dict:
 def _create_no_content_response(unmarshal_as: type[T]) -> T:
     """Create response for 204 No Content status."""
     try:
-        if hasattr(unmarshal_as, "__annotations__") and "result" in unmarshal_as.__annotations__:
-            return unmarshal_as(result="success")
+        # Check if the model has a 'result' field in its annotations
+        annotations = getattr(unmarshal_as, "__annotations__", {})
+        if "result" in annotations:
+            # Only pass result if the specific model supports it
+            try:
+                return unmarshal_as(result="success")  # type: ignore
+            except TypeError:
+                # Fallback if constructor doesn't accept result
+                pass
         return unmarshal_as()
     except Exception:
         resp = unmarshal_as.__new__(unmarshal_as)
@@ -77,23 +84,56 @@ def _handle_json_response(content: str, unmarshal_as: type[T]) -> T:
 
 def _handle_array_response(data: list, unmarshal_as: type[T]) -> T:
     """Handle array JSON responses."""
-    if hasattr(unmarshal_as, "__annotations__") and "data" in unmarshal_as.__annotations__:
-        return unmarshal_as(data=data)
-    return unmarshal_as(data=data)
+    try:
+        # Check if the model has a 'data' field in its annotations
+        annotations = getattr(unmarshal_as, "__annotations__", {})
+        if "data" in annotations:
+            try:
+                return unmarshal_as(data=data)  # type: ignore
+            except TypeError:
+                # Fallback if constructor doesn't accept data
+                pass
+        return unmarshal_as()
+    except Exception:
+        resp = unmarshal_as.__new__(unmarshal_as)
+        if hasattr(resp, "data"):
+            try:
+                object.__setattr__(resp, "data", data)
+            except Exception:
+                pass
+        return resp
 
 
 def _handle_primitive_response(value, unmarshal_as: type[T]) -> T:
     """Handle primitive JSON responses."""
-    if not hasattr(unmarshal_as, "__annotations__"):
-        return unmarshal_as()
-
-    annotations = unmarshal_as.__annotations__
-    if "result" in annotations:
-        return unmarshal_as(result=str(value))
-    elif "data" in annotations:
-        return unmarshal_as(data=value)
-    else:
+    try:
+        annotations = getattr(unmarshal_as, "__annotations__", {})
+        if "result" in annotations:
+            try:
+                return unmarshal_as(result=str(value))  # type: ignore
+            except TypeError:
+                # Fallback if constructor doesn't accept result
+                pass
+        elif "data" in annotations:
+            try:
+                return unmarshal_as(data=value)  # type: ignore
+            except TypeError:
+                # Fallback if constructor doesn't accept data
+                pass
         return unmarshal_as()
+    except Exception:
+        resp = unmarshal_as.__new__(unmarshal_as)
+        if hasattr(resp, "result"):
+            try:
+                object.__setattr__(resp, "result", str(value))
+            except Exception:
+                pass
+        elif hasattr(resp, "data"):
+            try:
+                object.__setattr__(resp, "data", value)
+            except Exception:
+                pass
+        return resp
 
 
 def _set_raw_response(resp: T, raw_resp: RawResponse) -> T:

{dify_oapi2-0.1.1.dist-info → dify_oapi2-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dify-oapi2
-Version: 0.1.1
+Version: 0.2.0
 Summary: A package for interacting with the Dify Service-API
 License: MIT
 Keywords: dify,nlp,ai,language-processing
@@ -122,10 +122,13 @@ asyncio.run(async_chat())
 - Conversation and message history management
 - Streaming and blocking response modes
 
-### Completion API
-- Text generation and completion
-- Custom input parameters
-- Streaming support
+### Completion API (15 APIs)
+- **Message Processing**: Send messages and control responses
+- **Annotation Management**: Create, update, and manage annotations
+- **Audio Processing**: Text-to-audio conversion
+- **Feedback System**: Collect and analyze user feedback
+- **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
@@ -261,6 +264,7 @@ dify-oapi/
 ## 📖 Documentation
 
 - [**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
 - [**Examples**](./examples/README.md) - Usage examples and patterns