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

dify_oapi2-0.5.0.dist-info/METADATA

@@ -1,335 +0,0 @@
-Metadata-Version: 2.3
-Name: dify-oapi2
-Version: 0.5.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@gmail.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,<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
-
-# 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 (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
-
-```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 (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
-- **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 (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
-- Parameter configuration
-- Status monitoring
-
-### Dify Core API
-- Essential Dify service functionality
-
-## 💡 Examples
-
-Explore comprehensive examples in the [examples directory](./examples):
-
-### Chat Examples
-- [**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
-- [**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).
-
-## 🛠️ 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/ # Knowledge Base API (33 APIs)
-│   │   ├── chatflow/    # Chatflow API (17 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
-- [**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/knowledge/apis.md) - Complete knowledge base 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
-