mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-03-27 13:28:32 +07:00
321 lines
19 KiB
Plaintext
321 lines
19 KiB
Plaintext
---
|
||
title: 拡張機能型プラグイン
|
||
---
|
||
|
||
|
||
|
||
{/*
|
||
コントリビューター注:
|
||
----------------
|
||
これはレガシードキュメントであり、非推奨になります。
|
||
このバージョンに変更を加えないでください。
|
||
すべての更新は新しいバージョンに向けられるべきです：
|
||
/plugin_dev_ja/9231-extension-plugin.ja
|
||
*/}
|
||
|
||
<Card title="このドキュメントはまもなく非推奨になります" icon="circle-exclamation" href="/plugin_dev_ja/9231-extension-plugin.ja">
|
||
<p>ドキュメント再編の一環として、このページは段階的に廃止されます。</p>
|
||
|
||
<p><u><b>このカードをクリックして</b></u>、最新情報が含まれる更新版にリダイレクトしてください。</p>
|
||
|
||
<p>新しいドキュメントに不一致や改善が必要な箇所を見つけた場合は、ページ下部の「問題を報告」ボタンを使用してください。</p>
|
||
</Card>
|
||
|
||
このドキュメントでは、Extensionタイプのプラグインを迅速に開発し、プラグイン開発の基本的な流れを理解するのに役立つように解説します。
|
||
|
||
### 事前準備
|
||
|
||
* Difyプラグインの足場ツール
|
||
* Python環境、バージョン番号 ≥ 3.12
|
||
|
||
プラグイン開発の足場ツールの準備方法については、[開発ツールの初期化](/ja-jp/plugins/quick-start/develop-plugins/initialize-development-tools)を参照してください。
|
||
|
||
### 新規プロジェクトの作成 <a href="#chuang-jian-xin-xiang-mu" id="chuang-jian-xin-xiang-mu"></a>
|
||
|
||
現在のパスで、足場コマンドラインツールを実行し、新しいDifyプラグインプロジェクトを作成します。
|
||
|
||
```
|
||
./dify-plugin-darwin-arm64 plugin init
|
||
```
|
||
|
||
このバイナリファイルを`dify`にリネームし、`/usr/local/bin`パスにコピーした場合、以下のコマンドを実行して新しいプラグインプロジェクトを作成できます。
|
||
|
||
```bash
|
||
dify plugin init
|
||
```
|
||
|
||
### **プラグイン情報の入力**
|
||
|
||
表示される指示に従って、プラグイン名、作者情報、プラグインの説明を設定してください。チームで共同作業する場合は、作者を組織名にすることも可能です。
|
||
|
||
> プラグイン名の長さは1〜128文字で、文字、数字、ダッシュ、アンダースコアのみを使用できます。
|
||
|
||
|
||
|
||
入力が完了したら、プラグイン開発言語の選択でPythonを選択してください。
|
||
|
||
<img
|
||
src="https://assets-docs.dify.ai/2024/11/1129101623ac4c091a3f6f75f4103848.png"
|
||
className="mx-auto"
|
||
alt=""
|
||
/>
|
||
|
||
### 3. プラグインタイプの選択とプロジェクトテンプレートの初期化
|
||
|
||
足場ツール内のすべてのテンプレートには、完全なコードプロジェクトが用意されています。このドキュメントでは、例として`Extension`タイプのプラグインテンプレートを使用します。プラグインに精通している開発者であれば、テンプレートを使用せずに、[APIドキュメント](/ja-jp/plugins/schema-definition/tool)を参照して様々なタイプのプラグイン開発を進めることができます。
|
||
|
||
|
||
|
||
#### プラグイン権限の設定
|
||
|
||
プラグインがDifyメインプラットフォームに正常に接続するためには、Difyメインプラットフォームの権限を読み取る必要があります。このサンプルプラグインには、以下の権限を付与してください。
|
||
|
||
* ツール
|
||
* LLM
|
||
* アプリ
|
||
* 永続ストレージを有効にし、デフォルトサイズのストレージを割り当てる
|
||
* エンドポイントの登録を許可する
|
||
|
||
> ターミナル内で方向キーを使って権限を選択し、「Tab」キーで権限を付与します。
|
||
|
||
すべての権限項目をチェックした後、Enterキーを押してプラグインの作成を完了します。システムが自動的にプラグインのプロジェクトコードを生成します。
|
||
|
||
|
||
|
||
プラグインの基本ファイル構造は以下の通りです。
|
||
|
||
```
|
||
.
|
||
├── GUIDE.md
|
||
├── README.md
|
||
├── _assets
|
||
│ └── icon.svg
|
||
├── endpoints
|
||
│ ├── your-project.py
|
||
│ └── your-project.yaml
|
||
├── group
|
||
│ └── your-project.yaml
|
||
├── main.py
|
||
├── manifest.yaml
|
||
└── requirements.txt
|
||
```
|
||
|
||
* `GUIDE.md`: プラグインの作成プロセスを説明する簡単なチュートリアルです。
|
||
* `README.md`: 現在のプラグインに関する情報です。このプラグインの概要や使用方法をこのファイルに記述する必要があります。
|
||
* `_assets`: 現在のプラグインに関連するすべてのマルチメディアファイルを保存します。
|
||
* `endpoints`: CLIのガイドに従って作成される`Extension`タイプのプラグインテンプレートです。このディレクトリには、すべてのエンドポイントの機能実装コードが格納されています。
|
||
* `group`: 秘密鍵のタイプ、多言語設定、API定義ファイルのパスを指定します。
|
||
* `main.py`: プロジェクト全体のエントリポイントとなるファイルです。
|
||
* `manifest.yaml`: プラグインの基本設定ファイルです。このプラグインに必要な権限、拡張機能の種類などの設定情報が含まれています。
|
||
* `requirements.txt`: Python環境の依存関係を記述します。
|
||
|
||
### プラグインの開発
|
||
|
||
#### 1. プラグインのリクエストエンドポイントの定義
|
||
|
||
`endpoints/test_plugin.yaml`を編集し、以下のコードを参考に変更してください。
|
||
|
||
```yaml
|
||
path: "/neko"
|
||
method: "GET"
|
||
extra:
|
||
python:
|
||
source: "endpoints/test_plugin.py"
|
||
```
|
||
|
||
このコードは、プラグインのエントリパスを`/neko`、リクエストメソッドをGETタイプとして定義するものです。プラグインの機能実装コードは、`endpoints/test_plugin.py`ファイルに記述します。
|
||
|
||
#### 2. プラグイン機能の作成
|
||
|
||
プラグインの機能：プラグインサービスをリクエストし、猫の情報を出力します。
|
||
|
||
プラグインの機能実装コードを`endpoints/test_plugin.py`ファイルに記述します。以下のサンプルコードを参考にしてください。
|
||
|
||
```python [expandable]
|
||
from typing import Mapping
|
||
from werkzeug import Request, Response
|
||
from flask import Flask, render_template_string
|
||
from dify_plugin import Endpoint
|
||
|
||
app = Flask(__name__)
|
||
|
||
class NekoEndpoint(Endpoint):
|
||
def _invoke(self, r: Request, values: Mapping, settings: Mapping) -> Response:
|
||
ascii_art = '''
|
||
⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛⬛️⬜️⬜️⬜️⬜️⬜⬜️⬜️️
|
||
🟥🟥⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️🟥🟥🟥🟥🟥🟥🟥🟥⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬛🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧⬛️⬜️⬜️⬜️⬜️⬜⬜️️
|
||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥⬛️🥧🥧🥧💟💟💟💟💟💟💟💟💟💟💟💟💟🥧🥧🥧⬛️⬜️⬜️⬜️⬜⬜️️
|
||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥⬛️🥧🥧💟💟💟💟💟💟🍓💟💟🍓💟💟💟💟💟🥧🥧⬛️⬜️⬜️⬜️⬜️⬜️️
|
||
🟧🟧🟥🟥🟥🟥🟥🟥🟥🟥🟧🟧🟧🟧🟧🟧🟧🟧🟥🟥🟥🟥🟥🟥🟥⬛🥧💟💟🍓💟💟💟💟💟💟💟💟💟💟💟💟💟💟🥧⬛️⬜️⬜️⬜️⬜⬜️️
|
||
🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧⬛️🥧💟💟💟💟💟💟💟💟💟💟⬛️⬛️💟💟🍓💟💟🥧⬛️⬜️⬛️️⬛️️⬜⬜️️
|
||
🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧🟧⬛️🥧💟💟💟💟💟💟💟💟💟⬛️🌫🌫⬛💟💟💟💟🥧⬛️⬛️🌫🌫⬛⬜️️
|
||
🟨🟨🟧🟧🟧🟧🟧🟧🟧🟧🟨🟨🟨🟨🟨🟨🟨🟨🟧⬛️⬛️⬛️⬛️🟧🟧⬛️🥧💟💟💟💟💟💟🍓💟💟⬛️🌫🌫🌫⬛💟💟💟🥧⬛️🌫🌫🌫⬛⬜️️
|
||
🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨⬛️🌫🌫⬛️⬛️🟧⬛️🥧💟💟💟💟💟💟💟💟💟⬛️🌫🌫🌫🌫⬛️⬛️⬛️⬛️🌫🌫🌫🌫⬛⬜️️
|
||
🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨⬛️⬛️🌫🌫⬛️⬛️⬛️🥧💟💟💟🍓💟💟💟💟💟⬛️🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫⬛⬜️️
|
||
🟩🟩🟨🟨🟨🟨🟨🟨🟨🟨🟩🟩🟩🟩🟩🟩🟩🟩🟨🟨⬛⬛️🌫🌫⬛️⬛️🥧💟💟💟💟💟💟💟🍓⬛️🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫⬛️
|
||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩⬛️⬛️🌫🌫⬛️🥧💟🍓💟💟💟💟💟💟⬛️🌫🌫🌫⬜️⬛️🌫🌫🌫🌫🌫⬜️⬛️🌫🌫⬛️
|
||
️🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩⬛️⬛️⬛️⬛️🥧💟💟💟💟💟💟💟💟⬛️🌫🌫🌫⬛️⬛️🌫🌫🌫⬛️🌫⬛️⬛️🌫🌫⬛️
|
||
🟦🟦🟩🟩🟩🟩🟩🟩🟩🟩🟦🟦🟦🟦🟦🟦🟦🟦🟩🟩🟩🟩🟩🟩⬛️⬛️🥧💟💟💟💟💟🍓💟💟⬛🌫🟥🟥🌫🌫🌫🌫🌫🌫🌫🌫🌫🟥🟥⬛️
|
||
🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦⬛️🥧🥧💟🍓💟💟💟💟💟⬛️🌫🟥🟥🌫⬛️🌫🌫⬛️🌫🌫⬛️🌫🟥🟥⬛️
|
||
🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦🟦⬛️🥧🥧🥧💟💟💟💟💟💟💟⬛️🌫🌫🌫⬛️⬛️⬛️⬛️⬛️⬛️⬛️🌫🌫⬛️⬜️
|
||
🟪🟪🟦🟦🟦🟦🟦🟦🟦🟦🟪🟪🟪🟪🟪🟪🟪🟪🟦🟦🟦🟦🟦🟦⬛️⬛️⬛️🥧🥧🥧🥧🥧🥧🥧🥧🥧🥧⬛️🌫🌫🌫🌫🌫🌫🌫🌫🌫🌫⬛️⬜️⬜️
|
||
🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪⬛️🌫🌫🌫⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬛️⬜️⬜️⬜️
|
||
🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪🟪⬛️🌫🌫⬛️⬛️⬜️⬛️🌫🌫⬛️⬜️⬜️⬜️⬜️⬜️⬛️🌫🌫⬛️⬜️⬛️🌫🌫⬛️⬜️⬜️⬜️⬜️
|
||
⬜️⬜️🟪🟪🟪🟪🟪🟪🟪🟪⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬜️🟪🟪🟪🟪🟪⬛️⬛️⬛️⬛⬜️⬜️⬛️⬛️⬛️⬜️⬜️⬜️⬜️⬜️⬜️⬜️⬛️⬛️⬛️⬜️⬜️⬛️⬛️⬜️⬜️⬜️⬜️⬜️️
|
||
'''
|
||
ascii_art_lines = ascii_art.strip().split('\n')
|
||
with app.app_context():
|
||
return Response(render_template_string('''
|
||
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<style>
|
||
body {
|
||
background-color: black;
|
||
color: white;
|
||
overflow: hidden;
|
||
margin: 0;
|
||
padding: 0;
|
||
}
|
||
#ascii-art {
|
||
font-family: monospace;
|
||
white-space: pre;
|
||
position: absolute;
|
||
top: 50%;
|
||
transform: translateY(-50%);
|
||
display: inline-block;
|
||
font-size: 16px;
|
||
line-height: 1;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<div id="ascii-art"></div>
|
||
<script>
|
||
var asciiArtLines = {{ ascii_art_lines | tojson }};
|
||
var asciiArtDiv = document.getElementById("ascii-art");
|
||
var index = 0;
|
||
function displayNextLine() {
|
||
if (index < asciiArtLines.length) {
|
||
var line = asciiArtLines[index];
|
||
var lineElement = document.createElement("div");
|
||
lineElement.innerHTML = line;
|
||
asciiArtDiv.appendChild(lineElement);
|
||
index++;
|
||
setTimeout(displayNextLine, 100);
|
||
} else {
|
||
animateCat();
|
||
}
|
||
}
|
||
function animateCat() {
|
||
var pos = 0;
|
||
var screenWidth = window.innerWidth;
|
||
var catWidth = asciiArtDiv.offsetWidth;
|
||
function move() {
|
||
asciiArtDiv.style.left = pos + "px";
|
||
pos += 2;
|
||
if (pos > screenWidth) {
|
||
pos = -catWidth;
|
||
}
|
||
requestAnimationFrame(move);
|
||
}
|
||
move();
|
||
}
|
||
displayNextLine();
|
||
</script>
|
||
</body>
|
||
</html>
|
||
''', ascii_art_lines=ascii_art_lines), status=200, content_type="text/html")
|
||
```
|
||
|
||
このコードを実行する前に、まず以下のPythonの依存パッケージをインストールする必要があります。
|
||
|
||
```python
|
||
pip install werkzeug
|
||
pip install flask
|
||
pip install dify-plugin
|
||
```
|
||
|
||
### プラグインのデバッグ
|
||
|
||
次に、プラグインが正常に動作するかどうかをテストします。Difyはリモートデバッグ機能を提供しており、「プラグイン管理」ページでデバッグキーとリモートサーバーのアドレスを取得できます。
|
||
|
||
|
||
|
||
プラグインのプロジェクトに戻り、`.env.example`ファイルをコピーして`.env`にリネームします。そして、取得したリモートサーバーのアドレスやデバッグキーなどの情報を`.env`ファイルに記入してください。
|
||
|
||
`.env`ファイルの内容：
|
||
|
||
```bash
|
||
INSTALL_METHOD=remote
|
||
REMOTE_INSTALL_HOST=remote
|
||
REMOTE_INSTALL_PORT=5003
|
||
REMOTE_INSTALL_KEY=****-****-****-****-****
|
||
```
|
||
|
||
`python -m main`コマンドを実行してプラグインを起動します。プラグインページで、このプラグインがワークスペースにインストールされたことを確認できます。他のチームメンバーもこのプラグインにアクセス可能です。
|
||
|
||
|
||
|
||
プラグイン内に新しいエンドポイントを追加し、名前や`api_key`などの情報を任意で入力します。自動生成されたURLにアクセスすると、プラグインが提供するウェブサービスが表示されます。
|
||
|
||
|
||
|
||
### プラグインのパッケージ化
|
||
|
||
プラグインが正常に動作することを確認したら、以下のコマンドラインツールを使用してプラグインをパッケージ化し、名前を付けることができます。実行後、現在のフォルダに`neko.difypkg`というファイルが生成されます。このファイルが最終的なプラグインパッケージです。
|
||
|
||
```bash
|
||
dify plugin package ./neko
|
||
```
|
||
|
||
おめでとうございます！これで、プラグインの開発、テスト、パッケージ化の全工程が完了しました。
|
||
|
||
### プラグインの公開
|
||
|
||
作成したプラグインは、[Dify Plugins コードリポジトリ](https://github.com/langgenius/dify-plugins)にアップロードして公開できます。アップロードする前に、プラグインが[プラグイン公開仕様](/ja-jp/plugins/publish-plugins/publish-to-dify-marketplace/README)に準拠していることを確認してください。審査に合格すると、コードはメインブランチにマージされ、[Dify Marketplace](https://marketplace.dify.ai/)に自動的に公開されます。
|
||
|
||
### さらに詳しく
|
||
|
||
**クイックスタート：**
|
||
|
||
* [バンドルタイププラグイン：複数のプラグインをまとめる](/ja-jp/plugins/quick-start/develop-plugins/bundle)
|
||
* [ツールタイププラグイン：Google検索](/ja-jp/plugins/quick-start/develop-plugins/tool-plugin)
|
||
* [モデルタイププラグイン](/ja-jp/plugins/quick-start/develop-plugins/bundle)
|
||
|
||
**プラグインインターフェースドキュメント：**
|
||
|
||
* [マニフェスト](/ja-jp/plugins/schema-definition/manifest)構造
|
||
* [エンドポイント](/ja-jp/plugins/schema-definition/endpoint)詳細定義
|
||
* [Dify機能の逆呼び出し](/ja-jp/plugins/schema-definition/reverse-invocation-of-the-dify-service/app)
|
||
* [ツール](/ja-jp/plugins/schema-definition/tool)
|
||
* [モデル](/ja-jp/plugins/schema-definition/reverse-invocation-of-the-dify-service/model)
|
||
* [拡張エージェント戦略](/ja-jp/plugins/schema-definition/agent)
|
||
|
||
**ベストプラクティス：**
|
||
|
||
[Slack Botプラグインの開発](/ja-jp/plugins/best-practice/develop-a-slack-bot-plugin)
|
||
|
||
{/*
|
||
Contributing Section
|
||
DO NOT edit this section!
|
||
It will be automatically generated by the script.
|
||
*/}
|
||
|
||
<CardGroup cols="2">
|
||
<Card
|
||
title="このページを編集する"
|
||
icon="pen-to-square"
|
||
href="https://github.com/langgenius/dify-docs-mintlify/edit/main/ja-jp/plugins/quick-start/develop-plugins/extension-plugin.mdx"
|
||
>
|
||
直接貢献することでドキュメントの改善にご協力ください
|
||
</Card>
|
||
<Card
|
||
title="問題を報告する"
|
||
icon="github"
|
||
href="https://github.com/langgenius/dify-docs-mintlify/issues/new?title=ドキュメントの問題%3A%20sion-plu&body=%23%23%20問題の説明%0A%3C%21--%20発見した問題について簡単に説明してください%20--%3E%0A%0A%23%23%20ページリンク%0Ahttps%3A%2F%2Fgithub.com%2Flanggenius%2Fdify-docs-mintlify%2Fblob%2Fmain%2Fja-jp/plugins/quick-start/develop-plugins%2Fextension-plugin.mdx%0A%0A%23%23%20提案される変更%0A%3C%21--%20特定の変更案がある場合は、ここで説明してください%20--%3E%0A%0A%3C%21--%20ドキュメントの品質向上にご協力いただきありがとうございます！%20--%3E"
|
||
>
|
||
エラーを見つけたり提案がありますか？お知らせください
|
||
</Card>
|
||
</CardGroup>
|