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

dify_oapi/core/http/transport/connection_pool.py

@@ -0,0 +1,131 @@
+"""HTTP connection pool management for efficient TCP connection reuse."""
+
+import threading
+from typing import Optional
+
+import httpx
+
+
+class ConnectionPoolManager:
+    """Manages HTTP connection pools to reduce TCP connection overhead."""
+
+    _instance: Optional["ConnectionPoolManager"] = None
+    _lock = threading.Lock()
+
+    def __new__(cls) -> "ConnectionPoolManager":
+        if cls._instance is None:
+            with cls._lock:
+                if cls._instance is None:
+                    cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(self):
+        if not hasattr(self, "_initialized"):
+            self._sync_clients: dict[str, httpx.Client] = {}
+            self._async_clients: dict[str, httpx.AsyncClient] = {}
+            self._client_lock = threading.Lock()
+            self._initialized = True
+
+    def get_sync_client(
+        self,
+        domain: str,
+        timeout: Optional[float] = None,
+        max_keepalive: int = 20,
+        max_connections: int = 100,
+        keepalive_expiry: float = 30.0,
+        verify_ssl: bool = True,
+    ) -> httpx.Client:
+        """Get or create a sync HTTP client for the given domain."""
+        client_key = f"{domain}:{timeout}:{max_keepalive}:{max_connections}:{keepalive_expiry}:{verify_ssl}"
+
+        with self._client_lock:
+            if client_key not in self._sync_clients:
+                # Configure connection limits to prevent excessive connections
+                limits = httpx.Limits(
+                    max_keepalive_connections=max_keepalive,
+                    max_connections=max_connections,
+                    keepalive_expiry=keepalive_expiry,
+                )
+
+                self._sync_clients[client_key] = httpx.Client(
+                    timeout=timeout,
+                    limits=limits,
+                    verify=verify_ssl,
+                    # Note: HTTP/2 disabled to avoid h2 dependency requirement
+                )
+
+            return self._sync_clients[client_key]
+
+    def get_async_client(
+        self,
+        domain: str,
+        timeout: Optional[float] = None,
+        max_keepalive: int = 20,
+        max_connections: int = 100,
+        keepalive_expiry: float = 30.0,
+        verify_ssl: bool = True,
+    ) -> httpx.AsyncClient:
+        """Get or create an async HTTP client for the given domain."""
+        client_key = f"{domain}:{timeout}:{max_keepalive}:{max_connections}:{keepalive_expiry}:{verify_ssl}"
+
+        with self._client_lock:
+            if client_key not in self._async_clients:
+                # Configure connection limits to prevent excessive connections
+                limits = httpx.Limits(
+                    max_keepalive_connections=max_keepalive,
+                    max_connections=max_connections,
+                    keepalive_expiry=keepalive_expiry,
+                )
+
+                self._async_clients[client_key] = httpx.AsyncClient(
+                    timeout=timeout,
+                    limits=limits,
+                    verify=verify_ssl,
+                    # Note: HTTP/2 disabled to avoid h2 dependency requirement
+                )
+
+            return self._async_clients[client_key]
+
+    def close_all(self):
+        """Close all HTTP clients and clean up connections."""
+        with self._client_lock:
+            # Close sync clients
+            for client in self._sync_clients.values():
+                try:
+                    client.close()
+                except Exception:
+                    pass
+            self._sync_clients.clear()
+
+            # Close async clients
+            for _client in self._async_clients.values():
+                try:
+                    # Note: This should be called from an async context in practice
+                    # For cleanup purposes, we'll just clear the dict
+                    pass
+                except Exception:
+                    pass
+            self._async_clients.clear()
+
+    async def aclose_all(self):
+        """Async version of close_all for proper async client cleanup."""
+        with self._client_lock:
+            # Close sync clients
+            for sync_client in self._sync_clients.values():
+                try:
+                    sync_client.close()
+                except Exception:
+                    pass
+            self._sync_clients.clear()
+
+            # Close async clients properly
+            for async_client in self._async_clients.values():
+                try:
+                    await async_client.aclose()
+                except Exception:
+                    pass
+            self._async_clients.clear()
+
+
+# Global connection pool manager instance
+connection_pool = ConnectionPoolManager()

dify_oapi/core/http/transport/sync_transport.py

@@ -17,6 +17,7 @@ from dify_oapi.core.model.request_option import RequestOption
 from dify_oapi.core.type import T
 
 from ._misc import _build_header, _build_url, _get_sleep_time, _merge_dicts, _unmarshaller
+from .connection_pool import connection_pool
 
 
 def _format_log_details(
@@ -45,6 +46,12 @@ def _handle_stream_error(response: httpx.Response) -> bytes:
     return f"data: [ERROR] {error_message}\n\n".encode()
 
 
+def _update_response_mode(body_data: dict | None, stream: bool) -> None:
+    """Update response_mode field in request body based on stream parameter"""
+    if body_data and "response_mode" in body_data:
+        body_data["response_mode"] = "streaming" if stream else "blocking"
+
+
 def _stream_generator(
     conf: Config,
     req: BaseRequest,
@@ -59,6 +66,16 @@ def _stream_generator(
     method_name = http_method.name
     body_data = _merge_dicts(json_, files, data)
 
+    # Use connection pool for streaming requests
+    client = connection_pool.get_sync_client(
+        conf.domain or "",
+        conf.timeout,
+        getattr(conf, "max_keepalive_connections", 20),
+        getattr(conf, "max_connections", 100),
+        getattr(conf, "keepalive_expiry", 30.0),
+        getattr(conf, "verify_ssl", True),
+    )
+
     for retry in range(conf.max_retry_count + 1):
         if retry > 0:
             sleep_time = _get_sleep_time(retry)
@@ -66,19 +83,16 @@ def _stream_generator(
             time.sleep(sleep_time)
 
         try:
-            with (
-                httpx.Client() as client,
-                client.stream(
-                    method_name,
-                    url,
-                    headers=headers,
-                    params=tuple(req.queries),
-                    json=json_,
-                    data=data,
-                    files=files,
-                    timeout=conf.timeout,
-                ) as response,
-            ):
+            with client.stream(
+                method_name,
+                url,
+                headers=headers,
+                params=tuple(req.queries),
+                json=json_,
+                data=data,
+                files=files,
+                timeout=conf.timeout,
+            ) as response:
                 logger.debug(
                     f"{_format_log_details(method_name, url, headers, req.queries, body_data)}, stream response"
                 )
@@ -160,8 +174,10 @@ class Transport:
             files = req.files
             if req.body is not None:
                 data = json.loads(JSON.marshal(req.body))
+                _update_response_mode(data, stream)
         elif req.body is not None:
             json_ = json.loads(JSON.marshal(req.body))
+            _update_response_mode(json_, stream)
 
         if stream:
             return _stream_generator(
@@ -176,45 +192,52 @@ class Transport:
         method_name = req.http_method.name
         body_data = _merge_dicts(json_, files, data)
 
-        with httpx.Client() as client:
-            for retry in range(conf.max_retry_count + 1):
-                if retry > 0:
-                    sleep_time = _get_sleep_time(retry)
-                    logger.info(f"in-request: sleep {sleep_time}s")
-                    time.sleep(sleep_time)
+        # Use connection pool for regular requests
+        client = connection_pool.get_sync_client(
+            conf.domain or "",
+            conf.timeout,
+            getattr(conf, "max_keepalive_connections", 20),
+            getattr(conf, "max_connections", 100),
+            getattr(conf, "keepalive_expiry", 30.0),
+            getattr(conf, "verify_ssl", True),
+        )
+
+        for retry in range(conf.max_retry_count + 1):
+            if retry > 0:
+                sleep_time = _get_sleep_time(retry)
+                logger.info(f"in-request: sleep {sleep_time}s")
+                time.sleep(sleep_time)
+
+            try:
+                response = client.request(
+                    method_name,
+                    url,
+                    headers=headers,
+                    params=tuple(req.queries),
+                    json=json_,
+                    data=data,
+                    files=files,
+                    timeout=conf.timeout,
+                )
+                break
+            except httpx.RequestError as e:
+                err_msg = f"{e.__class__.__name__}: {e!r}"
+                log_details = _format_log_details(method_name, url, headers, req.queries, body_data)
 
-                try:
-                    response = client.request(
-                        method_name,
-                        url,
-                        headers=headers,
-                        params=tuple(req.queries),
-                        json=json_,
-                        data=data,
-                        files=files,
-                        timeout=conf.timeout,
-                    )
-                    break
-                except httpx.RequestError as e:
-                    err_msg = f"{e.__class__.__name__}: {e!r}"
-                    log_details = _format_log_details(method_name, url, headers, req.queries, body_data)
-
-                    if retry < conf.max_retry_count:
-                        logger.info(
-                            f"in-request: retrying ({retry + 1}/{conf.max_retry_count}) {log_details}, exp: {err_msg}"
-                        )
-                        continue
+                if retry < conf.max_retry_count:
                     logger.info(
-                        f"in-request: request failed, retried ({retry}/{conf.max_retry_count}) {log_details}, exp: {err_msg}"
+                        f"in-request: retrying ({retry + 1}/{conf.max_retry_count}) {log_details}, exp: {err_msg}"
                     )
-                    raise
+                    continue
+                logger.info(
+                    f"in-request: request failed, retried ({retry}/{conf.max_retry_count}) {log_details}, exp: {err_msg}"
+                )
+                raise
 
-            logger.debug(
-                f"{_format_log_details(method_name, url, headers, req.queries, body_data)} {response.status_code}"
-            )
+        logger.debug(f"{_format_log_details(method_name, url, headers, req.queries, body_data)} {response.status_code}")
 
-            raw_resp = RawResponse()
-            raw_resp.status_code = response.status_code
-            raw_resp.headers = dict(response.headers)
-            raw_resp.content = response.content
-            return _unmarshaller(raw_resp, unmarshal_as)
+        raw_resp = RawResponse()
+        raw_resp.status_code = response.status_code
+        raw_resp.headers = dict(response.headers)
+        raw_resp.content = response.content
+        return _unmarshaller(raw_resp, unmarshal_as)

dify_oapi/core/model/config.py

@@ -1,3 +1,5 @@
+import ssl
+
 from dify_oapi.core.enum import LogLevel
 
 
@@ -7,3 +9,11 @@ class Config:
         self.timeout: float | None = None  # Client timeout in seconds, default is no timeout
         self.log_level: LogLevel = LogLevel.WARNING  # Log level, default is WARNING
         self.max_retry_count: int = 3  # Maximum retry count after request failure. Default is 3
+
+        # Connection pool settings
+        self.max_keepalive_connections: int = 20  # Max keepalive connections per pool
+        self.max_connections: int = 100  # Max total connections per pool
+        self.keepalive_expiry: float = 30.0  # Keepalive connection expiry time in seconds
+
+        # SSL settings
+        self.verify_ssl: ssl.SSLContext | str | bool = True  # SSL certificate verification

{dify_oapi2-0.3.0.dist-info → dify_oapi2-0.5.0.dist-info}/METADATA

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