dify-oapi2 0.1.0__tar.gz

dify_oapi2-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 LangGenius
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dify_oapi2-0.1.0/PKG-INFO

@@ -0,0 +1,295 @@
+Metadata-Version: 2.3
+Name: dify-oapi2
+Version: 0.1.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
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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)
+Project-URL: Homepage, https://github.com/nodite/dify-oapi2
+Project-URL: Source, https://github.com/nodite/dify-oapi2
+Description-Content-Type: text/markdown
+
+# Dify-OAPI
+
+[![PyPI version](https://badge.fury.io/py/dify-oapi2.svg)](https://badge.fury.io/py/dify-oapi2)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python SDK for interacting with the Dify Service-API. This library provides a fluent, type-safe interface for building AI-powered applications using Dify's API services including chat, completion, knowledge base, and workflow features.
+
+> This project is based on https://github.com/QiMington/dify-oapi, with refactoring and support for the latest Dify API.
+
+## ✨ Features
+
+- **Multiple API Services**: Chat, Completion, Knowledge Base (39 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
+
+## 📦 Installation
+
+```bash
+pip install dify-oapi2
+```
+
+**Requirements**: Python 3.10+
+
+**Dependencies**:
+- `pydantic` (>=1.10,<3.0.0) - Data validation and settings management
+- `httpx` (>=0.24,<1.0) - Modern HTTP client
+
+## 🚀 Quick Start
+
+### Basic Chat Example
+
+```python
+from dify_oapi.api.chat.v1.model.chat_request import ChatRequest
+from dify_oapi.api.chat.v1.model.chat_request_body import ChatRequestBody
+from dify_oapi.client import Client
+from dify_oapi.core.model.request_option import RequestOption
+
+# Initialize client
+client = Client.builder().domain("https://api.dify.ai").build()
+
+# Build request
+req_body = (
+    ChatRequestBody.builder()
+    .inputs({})
+    .query("What can Dify API do?")
+    .response_mode("blocking")
+    .user("user-123")
+    .build()
+)
+
+req = ChatRequest.builder().request_body(req_body).build()
+req_option = RequestOption.builder().api_key("your-api-key").build()
+
+# Execute request
+response = client.chat.v1.chat.chat(req, req_option, False)
+print(response.answer)
+```
+
+### Streaming Chat Example
+
+```python
+# Enable streaming for real-time responses
+req_body = (
+    ChatRequestBody.builder()
+    .query("Tell me a story")
+    .response_mode("streaming")
+    .user("user-123")
+    .build()
+)
+
+req = ChatRequest.builder().request_body(req_body).build()
+response = client.chat.v1.chat.chat(req, req_option, True)
+
+# Process streaming response
+for chunk in response:
+    print(chunk, end="", flush=True)
+```
+
+### Async Support
+
+```python
+import asyncio
+
+async def async_chat():
+    response = await client.chat.v1.chat.achat(req, req_option, False)
+    print(response.answer)
+
+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
+
+### Completion API
+- Text generation and completion
+- Custom input parameters
+- Streaming support
+
+### 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
+
+### Workflow API
+- Automated workflow execution
+- Parameter configuration
+- Status monitoring
+
+### Dify Core API
+- Essential Dify service functionality
+
+## 💡 Examples
+
+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
+
+### Completion Examples
+- [**Basic Completion**](./examples/completion/basic_completion.py) - Text generation
+
+### Knowledge Base Examples
+- [**List Datasets**](./examples/knowledge_base/list_datasets.py) - Dataset management
+
+For detailed examples and usage patterns, see the [examples README](./examples/README.md).
+
+## 🛠️ Development
+
+### Prerequisites
+- Python 3.10+
+- Poetry
+
+### Setup
+
+```bash
+# Clone repository
+git clone https://github.com/nodite/dify-oapi2.git
+cd dify-oapi
+
+# Setup development environment (installs dependencies and pre-commit hooks)
+make dev-setup
+```
+
+### Code Quality Tools
+
+This project uses modern Python tooling:
+
+- **Ruff**: Fast Python linter and formatter
+- **MyPy**: Static type checking
+- **Pre-commit**: Git hooks for code quality
+- **Pylint**: Additional code analysis
+
+```bash
+# Format code
+make format
+
+# Lint code
+make lint
+
+# Fix linting issues
+make fix
+
+# Run all checks (lint + type check)
+make check
+
+# Install pre-commit hooks
+make install-hooks
+
+# Run pre-commit hooks manually
+make pre-commit
+```
+
+### Testing
+
+```bash
+# Set environment variables
+export DOMAIN="https://api.dify.ai"
+export CHAT_KEY="your-api-key"
+
+# Run tests
+make test
+
+# Run tests with coverage
+make test-cov
+```
+
+### Build & Publish
+
+```bash
+# Configure PyPI tokens (one-time setup)
+poetry config http-basic.testpypi __token__ <your-testpypi-token>
+poetry config http-basic.pypi __token__ <your-pypi-token>
+
+# Build package
+make build
+
+# Publish to TestPyPI (for testing)
+make publish-test
+
+# Publish to PyPI (maintainers only)
+make publish
+```
+
+### Project Structure
+
+```
+dify-oapi/
+├── dify_oapi/           # Main SDK package
+│   ├── api/             # API service modules
+│   │   ├── chat/        # Chat API
+│   │   ├── completion/  # Completion API
+│   │   ├── dify/        # Core Dify API
+│   │   ├── knowledge_base/ # Knowledge Base API (39 APIs)
+│   │   └── workflow/    # Workflow API
+│   ├── core/            # Core functionality
+│   │   ├── http/        # HTTP transport layer
+│   │   ├── model/       # Base models
+│   │   └── utils/       # Utilities
+│   └── client.py        # Main client interface
+├── docs/                # Documentation
+├── examples/            # Usage examples
+├── tests/               # Test suite
+└── pyproject.toml       # Project configuration
+```
+
+## 📖 Documentation
+
+- [**Project Overview**](./docs/overview.md) - Architecture and technical details
+- [**Knowledge Base APIs**](./docs/datasets/apis.md) - Complete dataset API documentation
+- [**Examples**](./examples/README.md) - Usage examples and patterns
+
+## 🤝 Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Ensure code quality (`ruff format`, `ruff check`, `mypy`)
+5. Submit a pull request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## 🔗 Links
+
+- **PyPI Package**: https://pypi.org/project/dify-oapi2/
+- **Source Code**: https://github.com/nodite/dify-oapi2
+- **Dify Platform**: https://dify.ai/
+- **Dify API Docs**: https://docs.dify.ai/
+
+## 📄 License
+
+MIT License - see [LICENSE](./LICENSE) file for details.
+
+---
+
+**Keywords**: dify, nlp, ai, language-processing
+

dify_oapi2-0.1.0/README.md

@@ -0,0 +1,273 @@
+# Dify-OAPI
+
+[![PyPI version](https://badge.fury.io/py/dify-oapi2.svg)](https://badge.fury.io/py/dify-oapi2)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python SDK for interacting with the Dify Service-API. This library provides a fluent, type-safe interface for building AI-powered applications using Dify's API services including chat, completion, knowledge base, and workflow features.
+
+> This project is based on https://github.com/QiMington/dify-oapi, with refactoring and support for the latest Dify API.
+
+## ✨ Features
+
+- **Multiple API Services**: Chat, Completion, Knowledge Base (39 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
+
+## 📦 Installation
+
+```bash
+pip install dify-oapi2
+```
+
+**Requirements**: Python 3.10+
+
+**Dependencies**:
+- `pydantic` (>=1.10,<3.0.0) - Data validation and settings management
+- `httpx` (>=0.24,<1.0) - Modern HTTP client
+
+## 🚀 Quick Start
+
+### Basic Chat Example
+
+```python
+from dify_oapi.api.chat.v1.model.chat_request import ChatRequest
+from dify_oapi.api.chat.v1.model.chat_request_body import ChatRequestBody
+from dify_oapi.client import Client
+from dify_oapi.core.model.request_option import RequestOption
+
+# Initialize client
+client = Client.builder().domain("https://api.dify.ai").build()
+
+# Build request
+req_body = (
+    ChatRequestBody.builder()
+    .inputs({})
+    .query("What can Dify API do?")
+    .response_mode("blocking")
+    .user("user-123")
+    .build()
+)
+
+req = ChatRequest.builder().request_body(req_body).build()
+req_option = RequestOption.builder().api_key("your-api-key").build()
+
+# Execute request
+response = client.chat.v1.chat.chat(req, req_option, False)
+print(response.answer)
+```
+
+### Streaming Chat Example
+
+```python
+# Enable streaming for real-time responses
+req_body = (
+    ChatRequestBody.builder()
+    .query("Tell me a story")
+    .response_mode("streaming")
+    .user("user-123")
+    .build()
+)
+
+req = ChatRequest.builder().request_body(req_body).build()
+response = client.chat.v1.chat.chat(req, req_option, True)
+
+# Process streaming response
+for chunk in response:
+    print(chunk, end="", flush=True)
+```
+
+### Async Support
+
+```python
+import asyncio
+
+async def async_chat():
+    response = await client.chat.v1.chat.achat(req, req_option, False)
+    print(response.answer)
+
+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
+
+### Completion API
+- Text generation and completion
+- Custom input parameters
+- Streaming support
+
+### 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
+
+### Workflow API
+- Automated workflow execution
+- Parameter configuration
+- Status monitoring
+
+### Dify Core API
+- Essential Dify service functionality
+
+## 💡 Examples
+
+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
+
+### Completion Examples
+- [**Basic Completion**](./examples/completion/basic_completion.py) - Text generation
+
+### Knowledge Base Examples
+- [**List Datasets**](./examples/knowledge_base/list_datasets.py) - Dataset management
+
+For detailed examples and usage patterns, see the [examples README](./examples/README.md).
+
+## 🛠️ Development
+
+### Prerequisites
+- Python 3.10+
+- Poetry
+
+### Setup
+
+```bash
+# Clone repository
+git clone https://github.com/nodite/dify-oapi2.git
+cd dify-oapi
+
+# Setup development environment (installs dependencies and pre-commit hooks)
+make dev-setup
+```
+
+### Code Quality Tools
+
+This project uses modern Python tooling:
+
+- **Ruff**: Fast Python linter and formatter
+- **MyPy**: Static type checking
+- **Pre-commit**: Git hooks for code quality
+- **Pylint**: Additional code analysis
+
+```bash
+# Format code
+make format
+
+# Lint code
+make lint
+
+# Fix linting issues
+make fix
+
+# Run all checks (lint + type check)
+make check
+
+# Install pre-commit hooks
+make install-hooks
+
+# Run pre-commit hooks manually
+make pre-commit
+```
+
+### Testing
+
+```bash
+# Set environment variables
+export DOMAIN="https://api.dify.ai"
+export CHAT_KEY="your-api-key"
+
+# Run tests
+make test
+
+# Run tests with coverage
+make test-cov
+```
+
+### Build & Publish
+
+```bash
+# Configure PyPI tokens (one-time setup)
+poetry config http-basic.testpypi __token__ <your-testpypi-token>
+poetry config http-basic.pypi __token__ <your-pypi-token>
+
+# Build package
+make build
+
+# Publish to TestPyPI (for testing)
+make publish-test
+
+# Publish to PyPI (maintainers only)
+make publish
+```
+
+### Project Structure
+
+```
+dify-oapi/
+├── dify_oapi/           # Main SDK package
+│   ├── api/             # API service modules
+│   │   ├── chat/        # Chat API
+│   │   ├── completion/  # Completion API
+│   │   ├── dify/        # Core Dify API
+│   │   ├── knowledge_base/ # Knowledge Base API (39 APIs)
+│   │   └── workflow/    # Workflow API
+│   ├── core/            # Core functionality
+│   │   ├── http/        # HTTP transport layer
+│   │   ├── model/       # Base models
+│   │   └── utils/       # Utilities
+│   └── client.py        # Main client interface
+├── docs/                # Documentation
+├── examples/            # Usage examples
+├── tests/               # Test suite
+└── pyproject.toml       # Project configuration
+```
+
+## 📖 Documentation
+
+- [**Project Overview**](./docs/overview.md) - Architecture and technical details
+- [**Knowledge Base APIs**](./docs/datasets/apis.md) - Complete dataset API documentation
+- [**Examples**](./examples/README.md) - Usage examples and patterns
+
+## 🤝 Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Ensure code quality (`ruff format`, `ruff check`, `mypy`)
+5. Submit a pull request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## 🔗 Links
+
+- **PyPI Package**: https://pypi.org/project/dify-oapi2/
+- **Source Code**: https://github.com/nodite/dify-oapi2
+- **Dify Platform**: https://dify.ai/
+- **Dify API Docs**: https://docs.dify.ai/
+
+## 📄 License
+
+MIT License - see [LICENSE](./LICENSE) file for details.
+
+---
+
+**Keywords**: dify, nlp, ai, language-processing

dify_oapi2-0.1.0/dify_oapi/api/chat/service.py

@@ -0,0 +1,8 @@
+from dify_oapi.core.model.config import Config
+
+from .v1.version import V1
+
+
+class ChatService:
+    def __init__(self, config: Config) -> None:
+        self.v1: V1 = V1(config)

dify_oapi2-0.1.0/dify_oapi/api/chat/v1/model/audio_to_text_request.py

@@ -0,0 +1,40 @@
+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 .audio_to_text_request_body import AudioToTextRequestBody
+
+
+class AudioToTextRequest(BaseRequest):
+    def __init__(self):
+        super().__init__()
+        self.file: BytesIO | None = None
+        self.request_body: AudioToTextRequestBody | None = None
+
+    @staticmethod
+    def builder() -> AudioToTextRequestBuilder:
+        return AudioToTextRequestBuilder()
+
+
+class AudioToTextRequestBuilder:
+    def __init__(self):
+        audio_to_text_request = AudioToTextRequest()
+        audio_to_text_request.http_method = HttpMethod.POST
+        audio_to_text_request.uri = "/v1/audio-to-text"
+        self._audio_to_text_request = audio_to_text_request
+
+    def build(self) -> AudioToTextRequest:
+        return self._audio_to_text_request
+
+    def request_body(self, request_body: AudioToTextRequestBody) -> AudioToTextRequestBuilder:
+        self._audio_to_text_request.request_body = request_body
+        self._audio_to_text_request.body = request_body.model_dump(exclude_none=True, mode="json")
+        return self
+
+    def file(self, file: BytesIO, file_name: str) -> AudioToTextRequestBuilder:
+        self._audio_to_text_request.file = file
+        self._audio_to_text_request.files = {"file": (file_name, file)}
+        return self

dify_oapi2-0.1.0/dify_oapi/api/chat/v1/model/audio_to_text_request_body.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class AudioToTextRequestBody(BaseModel):
+    user: str | None = None
+
+    @staticmethod
+    def builder() -> AudioToTextRequestBodyBuilder:
+        return AudioToTextRequestBodyBuilder()
+
+
+class AudioToTextRequestBodyBuilder:
+    def __init__(self):
+        self._audio_to_text_request_body = AudioToTextRequestBody()
+
+    def build(self) -> AudioToTextRequestBody:
+        return self._audio_to_text_request_body
+
+    def user(self, user: str) -> AudioToTextRequestBodyBuilder:
+        self._audio_to_text_request_body.user = user
+        return self

dify_oapi2-0.1.0/dify_oapi/api/chat/v1/model/audio_to_text_response.py

@@ -0,0 +1,5 @@
+from dify_oapi.core.model.base_response import BaseResponse
+
+
+class AudioToTextResponse(BaseResponse):
+    text: str | None = None