Manifest

プラグイン manifest の YAML スキーマ。名前、作成者、ランタイム、リソース、権限、およびプラグインが提供するツール、モデル、エンドポイントを宣言します

このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。

manifest は、プラグインの基本情報（名前、作成者、含まれるツールやモデルなど）を定義する YAML ファイルです。ファイルの形式が正しくない場合、プラグインの解析とパッケージングは失敗します。

プラグインの全体的なアーキテクチャについては、プラグイン開発の基本概念 と 開発者チートシート を参照してください。

コード例

以下は簡単な manifest ファイルです。各フィールドについては、続く「構造」セクションで説明します。実際の例については、Google ツールプラグインの manifest を参照してください。

version: 0.0.1
type: "plugin"
author: "Yeuoly"
name: "neko"
label:
  en_US: "Neko"
created_at: "2024-07-12T08:03:44.658609186Z"
icon: "icon.svg"
resource:
  memory: 1048576
  permission:
    tool:
      enabled: true
    model:
      enabled: true
      llm: true
    endpoint:
      enabled: true
    app:
      enabled: true
    storage:
      enabled: true
      size: 1048576
plugins:
  endpoints:
    - "provider/neko.yaml"
meta:
  version: 0.0.1
  arch:
    - "amd64"
    - "arm64"
  runner:
    language: "python"
    version: "3.12"
    entrypoint: "main"
privacy: "./privacy.md"

構造

version · version · required

プラグインのバージョン。

type · string · required

プラグインタイプ。現在は plugin のみサポートされています。bundle のサポートは予定されています。

author · string · required

作成者。マーケットプレイスでは組織名として定義されます。

label · object · required

多言語名。

created_at · RFC3339 · required

作成時刻。マーケットプレイスでは現在時刻より後であってはなりません。

icon · string · required

アイコンパス。

resource · object

プラグインが申請するリソース。

memory · int64

最大メモリ使用量（バイト単位）。主に Dify Cloud 上の AWS Lambda のリソース割り当てに関連します。

permission · object

プラグインが申請する権限。

tool · object

ツールの逆呼び出し権限。

enabled · boolean

ツール権限を有効にするかどうか。

model · object

モデルの逆呼び出し権限。

enabled · boolean

モデル権限を有効にするかどうか。

llm · boolean

大規模言語モデル権限を有効にするかどうか。

text_embedding · boolean

テキスト埋め込みモデル権限を有効にするかどうか。

rerank · boolean

リランクモデル権限を有効にするかどうか。

tts · boolean

テキスト読み上げモデル権限を有効にするかどうか。

speech2text · boolean

音声認識モデル権限を有効にするかどうか。

moderation · boolean

コンテンツモデレーションモデル権限を有効にするかどうか。

node · object

ノードの逆呼び出し権限。

enabled · boolean

ノード権限を有効にするかどうか。

endpoint · object

endpoint を登録する権限。

enabled · boolean

endpoint 権限を有効にするかどうか。

app · object

app の逆呼び出し権限。

enabled · boolean

app 権限を有効にするかどうか。

storage · object

永続ストレージを申請する権限。

enabled · boolean

ストレージ権限を有効にするかどうか。

size · int64

許可される最大永続ストレージサイズ（バイト単位）。

plugins · object · required

プラグインが拡張する機能の YAML ファイルを、プラグインパッケージ内の絶対パスとして列挙します。例えば、モデルを拡張するには openai.yaml のようなファイルを定義し、ここにそのパスを記載します。ファイルがそのパスに存在しない場合、パッケージングは失敗します。

以下の組み合わせは許可されていません。

• ツールとモデルの両方を拡張する。
• モデルと Endpoints の両方を拡張する。
• 拡張が一切ない。

現在、各拡張タイプは 1 つの provider のみをサポートします。

tools · array[string]

ツール provider のプラグイン拡張。

models · array[string]

モデル provider のプラグイン拡張。

endpoints · array[string]

Endpoints provider のプラグイン拡張。

agent_strategies · array[string]

Agent 戦略 provider のプラグイン拡張。

meta · object · required

プラグインのメタデータ。

version · version · required

manifest 形式のバージョン。初期バージョンは 0.0.1 です。

arch · array[string] · required

サポートされるアーキテクチャ。現在は amd64 と arm64 のみサポートされています。

runner · object · required

ランタイム設定。

language · string · required

プログラミング言語。現在は Python のみサポートされています。

version · string · required

言語バージョン。現在は 3.12 のみサポートされています。

entrypoint · string · required

プログラムのエントリポイント。Python では main である必要があります。

privacy · string

プラグインのプライバシーポリシーの相対パスまたは URL。例："./privacy.md" または "https://your-web/privacy"。Dify マーケットプレイスへの掲載には必須であり、プラグインはユーザーデータの利用方法を明確に記載する必要があります。詳細については、プラグインプライバシーデータ保護ガイドライン を参照してください。