Skip to content

Commit c756a5e

Browse files
yinxulaiyinxulai
committed
docs: add README.md to plugin root directories
1 parent 42992d4 commit c756a5e

File tree

3 files changed

+255
-1
lines changed

3 files changed

+255
-1
lines changed

‎ai-models-provider/README.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Qiniu AI Models Plugin
2+
3+
Official Qiniu Cloud AI inference plugin for Dify, providing access to multiple advanced large language models.
4+
5+
## 📦 Plugin Information
6+
7+
- **Plugin Name**: ai-models-provider
8+
- **Author**: Qiniu Cloud
9+
- **License**: MIT License
10+
11+
## Features
12+
13+
### 🤖 Supported AI Models
14+
15+
This plugin connects to Qiniu Cloud AI inference platform, supporting multiple mainstream large language models, including but not limited to:
16+
17+
- **DeepSeek Series**: DeepSeek-R1, DeepSeek-V3, and other inference-optimized models
18+
- **Claude Series**: Anthropic Claude 3.5/4.x series advanced models
19+
- **GLM Series**: Zhipu GLM-4.x series Chinese-optimized models
20+
- **Qwen Series**: Alibaba Qwen3 series models
21+
- **Gemini Series**: Google Gemini 2.x/3.x series models
22+
- **Kimi Series**: Moonshot Kimi-K2 and other long-context models
23+
- **Other Models**: Grok, Doubao, MiniMax, and more
24+
25+
> 💡 **Note**: The model list is continuously updated. For the complete list, please check the Dify model provider configuration page or visit [Qiniu Cloud AI Platform](https://openai.qiniu.com/) for the latest supported models.
26+
27+
### ✨ Core Capabilities
28+
29+
All models support the following advanced features:
30+
31+
- ✅ Agent Thinking
32+
- ✅ Tool Calling
33+
- ✅ Multi-tool Calling
34+
- ✅ Streaming Tool Calls
35+
- ✅ Streaming Response
36+
37+
## Installation
38+
39+
### Install in Dify
40+
41+
1. Open Dify workspace
42+
2. Go to "Plugins" management page
43+
3. Select "Install Plugin"
44+
4. Choose one of the following installation methods:
45+
46+
#### Method 1: Install from GitHub Repository (Recommended)
47+
48+
```
49+
https://github.com/qiniu/dify-plugin
50+
```
51+
52+
#### Method 2: Install from Official Marketplace
53+
54+
Search for "Qiniu AI Models" in the plugin marketplace
55+
56+
### Configure Plugin
57+
58+
1. After successful installation, find "Qiniu AI Models" in the plugin list
59+
2. Click the "Configure" button
60+
3. Fill in the following information:
61+
62+
- **API Key**: Your Qiniu Cloud API key (required)
63+
- **API Endpoint URL**: Custom API endpoint (optional, default: https://openai.qiniu.com/v1)
64+
65+
4. Click "Save" to complete configuration
66+
67+
### Get API Key
68+
69+
1. Visit [Qiniu Cloud Developer Center](https://developer.qiniu.com/aitokenapi/12884/how-to-get-api-key)
70+
2. Log in to your Qiniu Cloud account
71+
3. Get your API Key from the API management page
72+
73+
## Usage Example
74+
75+
After configuration, you can use Qiniu Cloud AI models in Dify applications:
76+
77+
1. In the application orchestration page, select "Model Provider"
78+
2. Find the "Qiniu Cloud" provider
79+
3. Select the model you need (e.g., DeepSeek-V3, Claude 4.5 Sonnet, etc.)
80+
4. Start using!
81+
82+
## Technical Specifications
83+
84+
- **Architecture Support**: AMD64, ARM64
85+
- **Runtime Environment**: Python 3.12
86+
- **Memory Requirements**: 256 MB
87+
- **Dependencies**:
88+
- dify_plugin >= 0.3.0, < 0.5.0
89+
- requests >= 2.25.0
90+
91+
## Related Plugins
92+
93+
For Qiniu Cloud object storage functionality, please also install:
94+
95+
- **storage-tools**: Qiniu Cloud Storage Tools Plugin
96+
97+
## Support and Feedback
98+
99+
- **Issue Reporting**: [GitHub Issues](https://github.com/qiniu/dify-plugin/issues)
100+
- **Documentation**: [readme/README.md](readme/README.md)
101+
- **Chinese Documentation**: [readme/README_zh_Hans.md](readme/README_zh_Hans.md)

‎storage-tools/README.md‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Qiniu Storage Tools Plugin
2+
3+
Official Qiniu Cloud object storage tools plugin for Dify, providing comprehensive cloud storage management capabilities.
4+
5+
## 📦 Plugin Information
6+
7+
- **Plugin Name**: storage-tools
8+
- **Author**: Qiniu Cloud
9+
- **License**: MIT License
10+
11+
## Features
12+
13+
### 📁 Object Storage Tools
14+
15+
Provides complete Qiniu Cloud storage management functionality:
16+
17+
#### 1. List Buckets
18+
19+
View all storage buckets (Bucket) under your account.
20+
21+
- **Functionality**: Get all available storage buckets
22+
- **Returns**: List of bucket names
23+
- **Use case**: Understand your storage resource distribution
24+
25+
#### 2. File Upload
26+
27+
Upload files to a specified storage bucket.
28+
29+
- **Supported Features**:
30+
- Specify target storage bucket
31+
- Custom file prefix/path
32+
- Set custom domain
33+
- Return file access link
34+
- **Use case**: Store application-generated files, images, and other resources
35+
36+
#### 3. List Files
37+
38+
View the file list in a storage bucket.
39+
40+
- **Supported Features**:
41+
- Filter files by prefix
42+
- Paginated query
43+
- Limit number of results
44+
- **Use case**: Browse and manage files in storage buckets
45+
46+
#### 4. Get File Content
47+
48+
Get access links or content for private files.
49+
50+
- **Supported Features**:
51+
- Generate signed access links
52+
- Support private bucket file access
53+
- Set link expiration time
54+
- **Use case**: Securely access and share private files
55+
56+
## Installation
57+
58+
### Install in Dify
59+
60+
1. Open Dify workspace
61+
2. Go to "Plugins" management page
62+
3. Select "Install Plugin"
63+
4. Choose one of the following installation methods:
64+
65+
#### Method 1: Install from GitHub Repository (Recommended)
66+
67+
```
68+
https://github.com/qiniu/dify-plugin
69+
```
70+
71+
#### Method 2: Install from Official Marketplace
72+
73+
Search for "Qiniu Storage Tools" in the plugin marketplace
74+
75+
### Configure Plugin
76+
77+
1. After successful installation, find "Qiniu Storage Tools" in the plugin list
78+
2. Click the "Configure" button
79+
3. Fill in the following information:
80+
81+
- **Access Key**: Your Qiniu Cloud Access Key (required)
82+
- **Secret Key**: Your Qiniu Cloud Secret Key (required)
83+
84+
4. Click "Save" to complete configuration
85+
86+
### Get Credentials
87+
88+
1. Visit [Qiniu Cloud Console](https://portal.qiniu.com/user/key)
89+
2. Log in to your Qiniu Cloud account
90+
3. View or create your Access Key and Secret Key in the "Key Management" page
91+
92+
## Usage Example
93+
94+
After configuration, you can use Qiniu Cloud storage tools in Dify applications:
95+
96+
### Use in Workflow
97+
98+
1. In the workflow orchestration page, add a "Tool" node
99+
2. Select the "Qiniu Cloud Storage" toolset
100+
3. Choose the tool you need (List Buckets, File Upload, etc.)
101+
4. Configure tool parameters
102+
5. Connect to other nodes to build a complete workflow
103+
104+
### Use in Agent
105+
106+
1. Create or edit an Agent application
107+
2. In the "Tools" configuration section, enable "Qiniu Cloud Storage"
108+
3. Select specific tools to use
109+
4. The Agent can now call storage tools as needed
110+
111+
## Tool Parameter Descriptions
112+
113+
### File Upload
114+
115+
- **bucket**: (Required) Target storage bucket name
116+
- **file**: (Required) File content to upload (Base64 encoded)
117+
- **key_prefix**: (Optional) File storage path prefix
118+
- **domain**: (Optional) Custom access domain
119+
120+
### List Files
121+
122+
- **bucket**: (Required) Target storage bucket name
123+
- **prefix**: (Optional) File prefix filter
124+
- **marker**: (Optional) Pagination marker
125+
- **limit**: (Optional) Maximum number of results (default: 100)
126+
127+
### Get File Content
128+
129+
- **bucket**: (Required) Target storage bucket name
130+
- **key**: (Required) File key
131+
- **domain**: (Optional) Custom access domain
132+
- **expires**: (Optional) Link expiration time in seconds (default: 3600)
133+
134+
## Technical Specifications
135+
136+
- **Architecture Support**: AMD64, ARM64
137+
- **Runtime Environment**: Python 3.12
138+
- **Memory Requirements**: 256 MB
139+
- **Dependencies**:
140+
- dify_plugin >= 0.3.0, < 0.5.0
141+
- qiniu >= 7.13.0
142+
143+
## Related Plugins
144+
145+
For Qiniu Cloud AI model inference functionality, please also install:
146+
147+
- **ai-models-provider**: Qiniu AI Models Provider Plugin
148+
149+
## Support and Feedback
150+
151+
- **Issue Reporting**: [GitHub Issues](https://github.com/qiniu/dify-plugin/issues)
152+
- **Documentation**: [readme/README.md](readme/README.md)
153+
- **Chinese Documentation**: [readme/README_zh_Hans.md](readme/README_zh_Hans.md)

‎storage-tools/manifest.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ resource:
3939
tool:
4040
enabled: true
4141
type: plugin
42-
version: 0.2.0 # 插件实际版本号，发布时更新此版本
42+
version: 0.2.1 # 插件实际版本号，发布时更新此版本

0 commit comments

Comments
 (0)