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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dify-oapi2
-Version: 0.3.0
+Version: 0.5.0
 Summary: A package for interacting with the Dify Service-API
 License: MIT
 Keywords: dify,nlp,ai,language-processing
@@ -13,8 +13,8 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: httpx (>=0.24,<1.0)
-Requires-Dist: pydantic (>=1.10,<3.0.0)
+Requires-Dist: httpx (>=0,<1)
+Requires-Dist: pydantic (>=2,<3)
 Project-URL: Homepage, https://github.com/nodite/dify-oapi2
 Project-URL: Source, https://github.com/nodite/dify-oapi2
 Description-Content-Type: text/markdown
@@ -31,13 +31,14 @@ 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 (22 APIs), Completion (15 APIs), Knowledge Base (33 APIs), Chatflow (17 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
 - **Type Safety**: Comprehensive type hints with Pydantic validation
 - **File Upload**: Support for images and documents
 - **Modern HTTP Client**: Built on httpx for reliable API communication
+- **Connection Pool Optimization**: Efficient TCP connection reuse to reduce resource overhead
 
 ## 📦 Installation
 
@@ -116,11 +117,16 @@ asyncio.run(async_chat())
 
 ## 🔧 API Services
 
-### Chat API
-- Interactive conversations with AI assistants
-- File upload support (images, documents)
-- Conversation and message history management
-- Streaming and blocking response modes
+### Chat API (22 APIs)
+- **Chat Messages**: Interactive conversations with AI assistants (3 APIs)
+- **File Management**: Upload and manage images and documents (1 API)
+- **Feedback Management**: Collect and analyze user feedback (2 APIs)
+- **Conversation Management**: Complete conversation lifecycle management (5 APIs)
+- **Audio Processing**: Speech-to-text and text-to-speech capabilities (2 APIs)
+- **Application Information**: App configuration and metadata retrieval (4 APIs)
+- **Annotation Management**: Create and manage annotations with reply settings (6 APIs)
+- **Streaming Support**: Real-time streaming for chat and completion
+- **Type Safety**: Comprehensive type hints with strict Literal types
 
 ### Completion API (15 APIs)
 - **Message Processing**: Send messages and control responses
@@ -130,12 +136,24 @@ 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
+
+### Chatflow API (17 APIs)
+- **Advanced Chat**: 3 APIs for enhanced chat functionality with workflow events
+- **File Management**: 1 API for multimodal file upload and processing
+- **Feedback System**: 2 APIs for comprehensive feedback collection and analysis
+- **Conversation Management**: 5 APIs for complete conversation lifecycle management
+- **TTS Integration**: 2 APIs for speech-to-text and text-to-speech capabilities
+- **Application Configuration**: 4 APIs for app settings and metadata management
+- **Annotation System**: 6 APIs for annotation management and reply settings
+- **Streaming Support**: Real-time streaming with comprehensive event handling
+- **Type Safety**: Strict Literal types for all predefined values
 
 ### Workflow API
 - Automated workflow execution
@@ -150,15 +168,31 @@ asyncio.run(async_chat())
 Explore comprehensive examples in the [examples directory](./examples):
 
 ### Chat Examples
-- [**Blocking Response**](./examples/chat/blocking_response.py) - Standard chat interactions
-- [**Streaming Response**](./examples/chat/streaming_response.py) - Real-time streaming chat
-- [**Conversation Management**](./examples/chat/conversation_management.py) - Managing chat history
+- [**Chat Messages**](./examples/chat/chat/) - Send messages, stop generation, get suggestions
+- [**File Management**](./examples/chat/file/) - Upload and manage files
+- [**Feedback Management**](./examples/chat/feedback/) - Submit and retrieve feedback
+- [**Conversation Management**](./examples/chat/conversation/) - Complete conversation operations
+- [**Audio Processing**](./examples/chat/audio/) - Speech-to-text and text-to-speech
+- [**Application Information**](./examples/chat/app/) - App configuration and settings
+- [**Annotation Management**](./examples/chat/annotation/) - Annotation CRUD and reply settings
 
 ### Completion 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
+
+### Chatflow Examples
+- [**Advanced Chat**](./examples/chatflow/chatflow/) - Enhanced chat with streaming and workflow events
+- [**File Operations**](./examples/chatflow/file/) - Multimodal file upload and processing
+- [**Feedback Management**](./examples/chatflow/feedback/) - Comprehensive feedback collection
+- [**Conversation Management**](./examples/chatflow/conversation/) - Complete conversation operations
+- [**TTS Operations**](./examples/chatflow/tts/) - Speech-to-text and text-to-speech
+- [**Application Configuration**](./examples/chatflow/application/) - App settings and metadata
+- [**Annotation Management**](./examples/chatflow/annotation/) - Annotation CRUD and reply settings
 
 For detailed examples and usage patterns, see the [examples README](./examples/README.md).
 
@@ -248,7 +282,8 @@ 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)
+│   │   ├── chatflow/    # Chatflow API (17 APIs)
 │   │   └── workflow/    # Workflow API
 │   ├── core/            # Core functionality
 │   │   ├── http/        # HTTP transport layer
@@ -264,8 +299,9 @@ dify-oapi/
 ## 📖 Documentation
 
 - [**Project Overview**](./docs/overview.md) - Architecture and technical details
+- [**TCP Connection Optimization**](./docs/tcp-optimization.md) - Connection pool configuration and performance tuning
 - [**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.3.0 → dify_oapi2-0.5.0}/README.md

@@ -10,13 +10,14 @@ 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 (22 APIs), Completion (15 APIs), Knowledge Base (33 APIs), Chatflow (17 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
 - **Type Safety**: Comprehensive type hints with Pydantic validation
 - **File Upload**: Support for images and documents
 - **Modern HTTP Client**: Built on httpx for reliable API communication
+- **Connection Pool Optimization**: Efficient TCP connection reuse to reduce resource overhead
 
 ## 📦 Installation
 
@@ -95,11 +96,16 @@ asyncio.run(async_chat())
 
 ## 🔧 API Services
 
-### Chat API
-- Interactive conversations with AI assistants
-- File upload support (images, documents)
-- Conversation and message history management
-- Streaming and blocking response modes
+### Chat API (22 APIs)
+- **Chat Messages**: Interactive conversations with AI assistants (3 APIs)
+- **File Management**: Upload and manage images and documents (1 API)
+- **Feedback Management**: Collect and analyze user feedback (2 APIs)
+- **Conversation Management**: Complete conversation lifecycle management (5 APIs)
+- **Audio Processing**: Speech-to-text and text-to-speech capabilities (2 APIs)
+- **Application Information**: App configuration and metadata retrieval (4 APIs)
+- **Annotation Management**: Create and manage annotations with reply settings (6 APIs)
+- **Streaming Support**: Real-time streaming for chat and completion
+- **Type Safety**: Comprehensive type hints with strict Literal types
 
 ### Completion API (15 APIs)
 - **Message Processing**: Send messages and control responses
@@ -109,12 +115,24 @@ 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
+
+### Chatflow API (17 APIs)
+- **Advanced Chat**: 3 APIs for enhanced chat functionality with workflow events
+- **File Management**: 1 API for multimodal file upload and processing
+- **Feedback System**: 2 APIs for comprehensive feedback collection and analysis
+- **Conversation Management**: 5 APIs for complete conversation lifecycle management
+- **TTS Integration**: 2 APIs for speech-to-text and text-to-speech capabilities
+- **Application Configuration**: 4 APIs for app settings and metadata management
+- **Annotation System**: 6 APIs for annotation management and reply settings
+- **Streaming Support**: Real-time streaming with comprehensive event handling
+- **Type Safety**: Strict Literal types for all predefined values
 
 ### Workflow API
 - Automated workflow execution
@@ -129,15 +147,31 @@ asyncio.run(async_chat())
 Explore comprehensive examples in the [examples directory](./examples):
 
 ### Chat Examples
-- [**Blocking Response**](./examples/chat/blocking_response.py) - Standard chat interactions
-- [**Streaming Response**](./examples/chat/streaming_response.py) - Real-time streaming chat
-- [**Conversation Management**](./examples/chat/conversation_management.py) - Managing chat history
+- [**Chat Messages**](./examples/chat/chat/) - Send messages, stop generation, get suggestions
+- [**File Management**](./examples/chat/file/) - Upload and manage files
+- [**Feedback Management**](./examples/chat/feedback/) - Submit and retrieve feedback
+- [**Conversation Management**](./examples/chat/conversation/) - Complete conversation operations
+- [**Audio Processing**](./examples/chat/audio/) - Speech-to-text and text-to-speech
+- [**Application Information**](./examples/chat/app/) - App configuration and settings
+- [**Annotation Management**](./examples/chat/annotation/) - Annotation CRUD and reply settings
 
 ### Completion 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
+
+### Chatflow Examples
+- [**Advanced Chat**](./examples/chatflow/chatflow/) - Enhanced chat with streaming and workflow events
+- [**File Operations**](./examples/chatflow/file/) - Multimodal file upload and processing
+- [**Feedback Management**](./examples/chatflow/feedback/) - Comprehensive feedback collection
+- [**Conversation Management**](./examples/chatflow/conversation/) - Complete conversation operations
+- [**TTS Operations**](./examples/chatflow/tts/) - Speech-to-text and text-to-speech
+- [**Application Configuration**](./examples/chatflow/application/) - App settings and metadata
+- [**Annotation Management**](./examples/chatflow/annotation/) - Annotation CRUD and reply settings
 
 For detailed examples and usage patterns, see the [examples README](./examples/README.md).
 
@@ -227,7 +261,8 @@ 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)
+│   │   ├── chatflow/    # Chatflow API (17 APIs)
 │   │   └── workflow/    # Workflow API
 │   ├── core/            # Core functionality
 │   │   ├── http/        # HTTP transport layer
@@ -243,8 +278,9 @@ dify-oapi/
 ## 📖 Documentation
 
 - [**Project Overview**](./docs/overview.md) - Architecture and technical details
+- [**TCP Connection Optimization**](./docs/tcp-optimization.md) - Connection pool configuration and performance tuning
 - [**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.5.0/dify_oapi/api/chat/v1/model/__init__.py

@@ -0,0 +1,37 @@
+"""Chat API model package."""
+
+# Annotation Management Models
+from .configure_annotation_reply_request import ConfigureAnnotationReplyRequest
+from .configure_annotation_reply_request_body import ConfigureAnnotationReplyRequestBody
+from .configure_annotation_reply_response import ConfigureAnnotationReplyResponse
+from .create_annotation_request import CreateAnnotationRequest
+from .create_annotation_request_body import CreateAnnotationRequestBody
+from .create_annotation_response import CreateAnnotationResponse
+from .delete_annotation_request import DeleteAnnotationRequest
+from .delete_annotation_response import DeleteAnnotationResponse
+from .get_annotation_reply_status_request import GetAnnotationReplyStatusRequest
+from .get_annotation_reply_status_response import GetAnnotationReplyStatusResponse
+from .list_annotations_request import ListAnnotationsRequest
+from .list_annotations_response import ListAnnotationsResponse
+from .update_annotation_request import UpdateAnnotationRequest
+from .update_annotation_request_body import UpdateAnnotationRequestBody
+from .update_annotation_response import UpdateAnnotationResponse
+
+__all__ = [
+    # Annotation Management Models
+    "ConfigureAnnotationReplyRequest",
+    "ConfigureAnnotationReplyRequestBody",
+    "ConfigureAnnotationReplyResponse",
+    "CreateAnnotationRequest",
+    "CreateAnnotationRequestBody",
+    "CreateAnnotationResponse",
+    "DeleteAnnotationRequest",
+    "DeleteAnnotationResponse",
+    "GetAnnotationReplyStatusRequest",
+    "GetAnnotationReplyStatusResponse",
+    "ListAnnotationsRequest",
+    "ListAnnotationsResponse",
+    "UpdateAnnotationRequest",
+    "UpdateAnnotationRequestBody",
+    "UpdateAnnotationResponse",
+]

dify_oapi2-0.5.0/dify_oapi/api/chat/v1/model/agent_thought.py

@@ -0,0 +1,69 @@
+"""Agent thought model for Chat API."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class AgentThought(BaseModel):
+    """Agent thought model."""
+
+    id: str | None = None
+    message_id: str | None = None
+    position: int | None = None
+    thought: str | None = None
+    observation: str | None = None
+    tool: str | None = None
+    tool_input: str | None = None
+    message_files: list[str] | None = None
+    created_at: int | None = None
+
+    @staticmethod
+    def builder() -> AgentThoughtBuilder:
+        return AgentThoughtBuilder()
+
+
+class AgentThoughtBuilder:
+    """Builder for AgentThought."""
+
+    def __init__(self):
+        self._agent_thought = AgentThought()
+
+    def build(self) -> AgentThought:
+        return self._agent_thought
+
+    def id(self, id: str) -> AgentThoughtBuilder:
+        self._agent_thought.id = id
+        return self
+
+    def message_id(self, message_id: str) -> AgentThoughtBuilder:
+        self._agent_thought.message_id = message_id
+        return self
+
+    def position(self, position: int) -> AgentThoughtBuilder:
+        self._agent_thought.position = position
+        return self
+
+    def thought(self, thought: str) -> AgentThoughtBuilder:
+        self._agent_thought.thought = thought
+        return self
+
+    def observation(self, observation: str) -> AgentThoughtBuilder:
+        self._agent_thought.observation = observation
+        return self
+
+    def tool(self, tool: str) -> AgentThoughtBuilder:
+        self._agent_thought.tool = tool
+        return self
+
+    def tool_input(self, tool_input: str) -> AgentThoughtBuilder:
+        self._agent_thought.tool_input = tool_input
+        return self
+
+    def message_files(self, message_files: list[str]) -> AgentThoughtBuilder:
+        self._agent_thought.message_files = message_files
+        return self
+
+    def created_at(self, created_at: int) -> AgentThoughtBuilder:
+        self._agent_thought.created_at = created_at
+        return self

dify_oapi2-0.5.0/dify_oapi/api/chat/v1/model/annotation_info.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class AnnotationInfo(BaseModel):
+    id: str | None = None
+    question: str | None = None
+    answer: str | None = None
+    hit_count: int | None = None
+    created_at: int | None = None
+
+    @staticmethod
+    def builder() -> AnnotationInfoBuilder:
+        return AnnotationInfoBuilder()
+
+
+class AnnotationInfoBuilder:
+    def __init__(self):
+        self._annotation_info = AnnotationInfo()
+
+    def id(self, id: str) -> AnnotationInfoBuilder:
+        self._annotation_info.id = id
+        return self
+
+    def question(self, question: str) -> AnnotationInfoBuilder:
+        self._annotation_info.question = question
+        return self
+
+    def answer(self, answer: str) -> AnnotationInfoBuilder:
+        self._annotation_info.answer = answer
+        return self
+
+    def hit_count(self, hit_count: int) -> AnnotationInfoBuilder:
+        self._annotation_info.hit_count = hit_count
+        return self
+
+    def created_at(self, created_at: int) -> AnnotationInfoBuilder:
+        self._annotation_info.created_at = created_at
+        return self
+
+    def build(self) -> AnnotationInfo:
+        return self._annotation_info

dify_oapi2-0.5.0/dify_oapi/api/chat/v1/model/app_info.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class AppInfo(BaseModel):
+    """Application basic information model."""
+
+    name: str
+    description: str
+    tags: list[str]
+
+    @staticmethod
+    def builder() -> AppInfoBuilder:
+        return AppInfoBuilder()
+
+
+class AppInfoBuilder:
+    def __init__(self):
+        self._app_info = AppInfo(name="", description="", tags=[])
+
+    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