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

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

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

{dify_oapi2-0.2.0 → dify_oapi2-0.4.0}/README.md

@@ -10,7 +10,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
@@ -109,12 +109,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
@@ -137,7 +138,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).
 
@@ -227,7 +231,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
@@ -244,7 +248,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

dify_oapi2-0.4.0/dify_oapi/api/completion/v1/model/completion/completion_inputs.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class CompletionInputs(BaseModel):
+    """
+    Inputs for completion application containing variables defined in the App.
+    Text generation applications require at least the query field.
+    Additional custom variables can be added as needed.
+    """
+
+    query: str  # Required: User input text content
+
+    # Allow additional fields for custom variables
+    model_config = {"extra": "allow"}
+
+    @staticmethod
+    def builder() -> CompletionInputsBuilder:
+        return CompletionInputsBuilder()
+
+    def with_variables(self, **kwargs: Any) -> CompletionInputs:
+        result: CompletionInputs = self.model_copy(update=kwargs)
+        return result
+
+
+class CompletionInputsBuilder:
+    def __init__(self):
+        self._inputs: CompletionInputs | None = None
+
+    def build(self) -> CompletionInputs:
+        if self._inputs is None:
+            raise ValueError("query field is required for CompletionInputs")
+        return self._inputs
+
+    def query(self, query: str) -> CompletionInputsBuilder:
+        self._inputs = CompletionInputs(query=query)
+        return self
+
+    def add_variable(self, key: str, value: Any) -> CompletionInputsBuilder:
+        if self._inputs is None:
+            raise ValueError("Must set query first")
+        self._inputs = self._inputs.with_variables(**{key: value})
+        return self
+
+    def variables(self, **kwargs: Any) -> CompletionInputsBuilder:
+        if self._inputs is None:
+            raise ValueError("Must set query first")
+        self._inputs = self._inputs.with_variables(**kwargs)
+        return self

dify_oapi2-0.4.0/dify_oapi/api/completion/v1/model/completion/completion_types.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+from typing import Literal
+
+# Response mode types
+ResponseMode = Literal["streaming", "blocking"]
+
+# File types
+FileType = Literal["image"]
+
+# Transfer method types
+TransferMethod = Literal["remote_url", "local_file"]
+
+# Feedback rating types
+FeedbackRating = Literal["like", "dislike"]
+
+# Annotation action types
+AnnotationAction = Literal["enable", "disable"]
+
+# Icon types
+IconType = Literal["emoji", "image"]
+
+# App mode types
+AppMode = Literal["completion"]
+
+# Job status types
+JobStatus = Literal["waiting", "running", "completed", "failed"]
+
+# Event types for streaming
+EventType = Literal["message", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"]
+
+# User input form types
+UserInputFormType = Literal["text-input", "paragraph", "select"]
+
+# Audio format types
+AudioFormat = Literal["mp3", "wav"]
+
+# Image format types
+ImageFormat = Literal["png", "jpg", "jpeg", "webp", "gif"]
+
+# Currency types (common currencies)
+CurrencyType = Literal["USD", "EUR", "CNY", "JPY", "GBP"]
+
+# Language codes (common language codes)
+LanguageCode = Literal["en-US", "zh-CN", "ja-JP", "ko-KR", "fr-FR", "de-DE", "es-ES", "pt-BR", "ru-RU"]

dify_oapi2-0.4.0/dify_oapi/api/completion/v1/model/completion/input_file_object.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, field_validator
+
+from .completion_types import FileType, TransferMethod
+
+
+class InputFileObject(BaseModel):
+    """File input object for multimodal understanding."""
+
+    type: FileType
+    transfer_method: TransferMethod
+    url: str | None = None
+    upload_file_id: str | None = None
+
+    @field_validator("url", "upload_file_id")
+    @classmethod
+    def validate_transfer_method_fields(cls, v, info):
+        """Validate that the correct field is provided based on transfer_method."""
+        if info.data.get("transfer_method") == "remote_url":
+            if info.field_name == "url" and v is None:
+                raise ValueError("url is required when transfer_method is remote_url")
+            if info.field_name == "upload_file_id" and v is not None:
+                raise ValueError("upload_file_id must not be provided when transfer_method is remote_url")
+        elif info.data.get("transfer_method") == "local_file":
+            if info.field_name == "upload_file_id" and v is None:
+                raise ValueError("upload_file_id is required when transfer_method is local_file")
+            if info.field_name == "url" and v is not None:
+                raise ValueError("url must not be provided when transfer_method is local_file")
+        return v
+
+    @staticmethod
+    def builder() -> InputFileObjectBuilder:
+        return InputFileObjectBuilder()
+
+
+class InputFileObjectBuilder:
+    def __init__(self):
+        self._file_object = InputFileObject(type="image", transfer_method="remote_url")
+
+    def build(self) -> InputFileObject:
+        return self._file_object
+
+    def type(self, type_: FileType) -> InputFileObjectBuilder:
+        self._file_object.type = type_
+        return self
+
+    def transfer_method(self, transfer_method: TransferMethod) -> InputFileObjectBuilder:
+        self._file_object.transfer_method = transfer_method
+        return self
+
+    def url(self, url: str) -> InputFileObjectBuilder:
+        self._file_object.url = url
+        return self
+
+    def upload_file_id(self, upload_file_id: str) -> InputFileObjectBuilder:
+        self._file_object.upload_file_id = upload_file_id
+        return self

dify_oapi2-0.4.0/dify_oapi/api/completion/v1/model/completion/send_message_request_body.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel, field_validator
+
+from .completion_inputs import CompletionInputs
+from .completion_types import ResponseMode
+from .input_file_object import InputFileObject
+
+
+class SendMessageRequestBody(BaseModel):
+    """Request body for sending completion messages."""
+
+    inputs: dict[str, Any]  # Variable values defined by the App, must include 'query'
+    response_mode: ResponseMode | None = "streaming"
+    user: str | None = None
+    files: list[InputFileObject] | None = None
+
+    @field_validator("inputs")
+    @classmethod
+    def validate_inputs(cls, v):
+        """Validate that inputs contains the required 'query' field."""
+        if not isinstance(v, dict):
+            raise ValueError("inputs must be a dictionary")
+        if "query" not in v:
+            raise ValueError('inputs must contain a "query" field')
+        if not isinstance(v["query"], str):
+            raise ValueError("query field must be a string")
+        return v
+
+    @staticmethod
+    def builder() -> SendMessageRequestBodyBuilder:
+        return SendMessageRequestBodyBuilder()
+
+
+class SendMessageRequestBodyBuilder:
+    def __init__(self):
+        self._send_message_request_body = SendMessageRequestBody(inputs={"query": ""})
+
+    def build(self) -> SendMessageRequestBody:
+        return self._send_message_request_body
+
+    def inputs(self, inputs: CompletionInputs | dict[str, Any]) -> SendMessageRequestBodyBuilder:
+        """Set inputs from CompletionInputs object or dictionary."""
+        if isinstance(inputs, CompletionInputs):
+            self._send_message_request_body.inputs = inputs.model_dump()
+        else:
+            self._send_message_request_body.inputs = inputs
+        return self
+
+    def query(self, query: str) -> SendMessageRequestBodyBuilder:
+        """Set the query field directly."""
+        self._send_message_request_body.inputs["query"] = query
+        return self
+
+    def add_variable(self, key: str, value: str) -> SendMessageRequestBodyBuilder:
+        """Add a custom variable to inputs."""
+        self._send_message_request_body.inputs[key] = value
+        return self
+
+    def response_mode(self, response_mode: ResponseMode) -> SendMessageRequestBodyBuilder:
+        self._send_message_request_body.response_mode = response_mode
+        return self
+
+    def user(self, user: str) -> SendMessageRequestBodyBuilder:
+        self._send_message_request_body.user = user
+        return self
+
+    def files(self, files: list[InputFileObject]) -> SendMessageRequestBodyBuilder:
+        self._send_message_request_body.files = files
+        return self

{dify_oapi2-0.2.0 → dify_oapi2-0.4.0}/dify_oapi/api/completion/v1/model/completion/usage.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
+from .completion_types import CurrencyType
+
 
 class Usage(BaseModel):
     prompt_tokens: int | None = None
@@ -14,7 +16,7 @@ class Usage(BaseModel):
     completion_price: str | None = None
     total_tokens: int | None = None
     total_price: str | None = None
-    currency: str | None = None
+    currency: CurrencyType | None = None
     latency: float | None = None
 
     @staticmethod
@@ -69,7 +71,7 @@ class UsageBuilder:
         self._usage.total_price = total_price
         return self
 
-    def currency(self, currency: str) -> UsageBuilder:
+    def currency(self, currency: CurrencyType) -> UsageBuilder:
         self._usage.currency = currency
         return self
 

dify_oapi2-0.4.0/dify_oapi/api/completion/v1/model/info/feature_config.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class SuggestedQuestionsAfterAnswerConfig(BaseModel):
+    """Configuration for suggested questions after answer feature."""
+
+    enabled: bool
+
+    @staticmethod
+    def builder() -> SuggestedQuestionsAfterAnswerConfigBuilder:
+        return SuggestedQuestionsAfterAnswerConfigBuilder()
+
+
+class SuggestedQuestionsAfterAnswerConfigBuilder:
+    def __init__(self):
+        self._config = SuggestedQuestionsAfterAnswerConfig(enabled=False)
+
+    def build(self) -> SuggestedQuestionsAfterAnswerConfig:
+        return self._config
+
+    def enabled(self, enabled: bool) -> SuggestedQuestionsAfterAnswerConfigBuilder:
+        self._config.enabled = enabled
+        return self
+
+
+class SpeechToTextConfig(BaseModel):
+    """Configuration for speech to text feature."""
+
+    enabled: bool
+
+    @staticmethod
+    def builder() -> SpeechToTextConfigBuilder:
+        return SpeechToTextConfigBuilder()
+
+
+class SpeechToTextConfigBuilder:
+    def __init__(self):
+        self._config = SpeechToTextConfig(enabled=False)
+
+    def build(self) -> SpeechToTextConfig:
+        return self._config
+
+    def enabled(self, enabled: bool) -> SpeechToTextConfigBuilder:
+        self._config.enabled = enabled
+        return self
+
+
+class RetrieverResourceConfig(BaseModel):
+    """Configuration for retriever resource (citation and attribution) feature."""
+
+    enabled: bool
+
+    @staticmethod
+    def builder() -> RetrieverResourceConfigBuilder:
+        return RetrieverResourceConfigBuilder()
+
+
+class RetrieverResourceConfigBuilder:
+    def __init__(self):
+        self._config = RetrieverResourceConfig(enabled=False)
+
+    def build(self) -> RetrieverResourceConfig:
+        return self._config
+
+    def enabled(self, enabled: bool) -> RetrieverResourceConfigBuilder:
+        self._config.enabled = enabled
+        return self
+
+
+class AnnotationReplyConfig(BaseModel):
+    """Configuration for annotation reply feature."""
+
+    enabled: bool
+
+    @staticmethod
+    def builder() -> AnnotationReplyConfigBuilder:
+        return AnnotationReplyConfigBuilder()
+
+
+class AnnotationReplyConfigBuilder:
+    def __init__(self):
+        self._config = AnnotationReplyConfig(enabled=False)
+
+    def build(self) -> AnnotationReplyConfig:
+        return self._config
+
+    def enabled(self, enabled: bool) -> AnnotationReplyConfigBuilder:
+        self._config.enabled = enabled
+        return self

{dify_oapi2-0.2.0 → dify_oapi2-0.4.0}/dify_oapi/api/completion/v1/model/info/parameters_info.py

@@ -2,6 +2,12 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
+from .feature_config import (
+    AnnotationReplyConfig,
+    RetrieverResourceConfig,
+    SpeechToTextConfig,
+    SuggestedQuestionsAfterAnswerConfig,
+)
 from .file_upload_config import FileUploadConfig
 from .system_parameters import SystemParameters
 from .user_input_form import UserInputForm
@@ -10,10 +16,10 @@ from .user_input_form import UserInputForm
 class ParametersInfo(BaseModel):
     opening_statement: str | None = None
     suggested_questions: list[str] | None = None
-    suggested_questions_after_answer: dict | None = None
-    speech_to_text: dict | None = None
-    retriever_resource: dict | None = None
-    annotation_reply: dict | None = None
+    suggested_questions_after_answer: SuggestedQuestionsAfterAnswerConfig | None = None
+    speech_to_text: SpeechToTextConfig | None = None
+    retriever_resource: RetrieverResourceConfig | None = None
+    annotation_reply: AnnotationReplyConfig | None = None
     user_input_form: list[UserInputForm] | None = None
     file_upload: FileUploadConfig | None = None
     system_parameters: SystemParameters | None = None
@@ -38,19 +44,21 @@ class ParametersInfoBuilder:
         self._parameters_info.suggested_questions = suggested_questions
         return self
 
-    def suggested_questions_after_answer(self, suggested_questions_after_answer: dict) -> ParametersInfoBuilder:
+    def suggested_questions_after_answer(
+        self, suggested_questions_after_answer: SuggestedQuestionsAfterAnswerConfig
+    ) -> ParametersInfoBuilder:
         self._parameters_info.suggested_questions_after_answer = suggested_questions_after_answer
         return self
 
-    def speech_to_text(self, speech_to_text: dict) -> ParametersInfoBuilder:
+    def speech_to_text(self, speech_to_text: SpeechToTextConfig) -> ParametersInfoBuilder:
         self._parameters_info.speech_to_text = speech_to_text
         return self
 
-    def retriever_resource(self, retriever_resource: dict) -> ParametersInfoBuilder:
+    def retriever_resource(self, retriever_resource: RetrieverResourceConfig) -> ParametersInfoBuilder:
         self._parameters_info.retriever_resource = retriever_resource
         return self
 
-    def annotation_reply(self, annotation_reply: dict) -> ParametersInfoBuilder:
+    def annotation_reply(self, annotation_reply: AnnotationReplyConfig) -> ParametersInfoBuilder:
         self._parameters_info.annotation_reply = annotation_reply
         return self
 

{dify_oapi2-0.2.0 → dify_oapi2-0.4.0}/dify_oapi/api/completion/v1/model/info/site_info.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from ..completion.completion_types import IconType
+from ..completion.completion_types import IconType, LanguageCode
 
 
 class SiteInfo(BaseModel):
@@ -17,7 +17,7 @@ class SiteInfo(BaseModel):
     copyright: str | None = None
     privacy_policy: str | None = None
     custom_disclaimer: str | None = None
-    default_language: str | None = None
+    default_language: LanguageCode | None = None
     show_workflow_steps: bool | None = None
     use_icon_as_answer_icon: bool | None = None
 
@@ -77,7 +77,7 @@ class SiteInfoBuilder:
         self._site_info.custom_disclaimer = custom_disclaimer
         return self
 
-    def default_language(self, default_language: str) -> SiteInfoBuilder:
+    def default_language(self, default_language: LanguageCode) -> SiteInfoBuilder:
         self._site_info.default_language = default_language
         return self