Manifest

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

Manifestは、プラグインの最も基本的な情報を定義するYAML準拠のファイルです。プラグイン名、作成者、含まれるツール、モデルなどが含まれますが、これらに限定されません。プラグインの全体的なアーキテクチャについては、プラグイン開発の基本概念と開発者チートシートを参照してください。

このファイルのフォーマットが正しくない場合、プラグインの解析とパッケージングプロセスは失敗します。

​

コード例

以下はManifestファイルの簡単な例です。各データ項目の意味と機能については後で説明します。

他のプラグインの参照コードについては、GitHubコードリポジトリを参照してください。

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.10"
    entrypoint: "main"
privacy: "./privacy.md"

​

構造

version · version · 必須

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

type · string · 必須

プラグインタイプ。現在はpluginのみサポートされており、将来的にbundleがサポートされる予定です。

author · string · 必須

作成者。Marketplaceでは組織名として定義されます。

label · object · 必須

多言語名。

created_at · RFC3339 · 必須

作成時刻。Marketplaceでは現在時刻より後であってはなりません。

icon · string · 必須

アイコンパス。

resource · object

申請するリソース。

memory · int64

最大メモリ使用量。主にSaaS上のAWS Lambdaリソース申請に関連します。単位はバイトです。

permission · object

権限申請。

tool · object

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

enabled · boolean

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

model · object

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

enabled · boolean

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

llm · boolean

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

text_embedding · boolean

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

rerank · boolean

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

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 · 必須

プラグインによって拡張される特定の機能のyamlファイルのリスト。プラグインパッケージ内の絶対パスです。例えば、モデルを拡張する必要がある場合、openai.yamlのようなファイルを定義し、ここにファイルパスを記入する必要があります。このパスにファイルが実際に存在しない場合、パッケージングは失敗します。

ツールとモデルを同時に拡張することは許可されていません。

拡張がないことは許可されていません。

モデルとEndpointsを同時に拡張することは許可されていません。

現在、各タイプの拡張では1つのプロバイダーのみがサポートされています。

tools · array[string]

ツールプロバイダーのプラグイン拡張。

models · array[string]

モデルプロバイダーのプラグイン拡張。

endpoints · array[string]

Endpointsプロバイダーのプラグイン拡張。

agent_strategies · array[string]

エージェント戦略プロバイダーのプラグイン拡張。

meta · object · 必須

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

version · version · 必須

manifestフォーマットバージョン。初期バージョンは0.0.1です。

arch · array[string] · 必須

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

runner · object · 必須

ランタイム設定。

language · string · 必須

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

version · string · 必須

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

entrypoint · string · 必須

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

privacy · string

プラグインのプライバシーポリシーファイルの相対パスまたはURLを指定します。例："./privacy.md"または"https://your-web/privacy"。プラグインをDify Marketplaceに掲載する予定がある場合、明確なユーザーデータの使用とプライバシーに関する声明を提供するためにこのフィールドは必須です。詳細な記入ガイドラインについては、プラグインプライバシーデータ保護ガイドラインを参照してください。

---

Edit this page | Report an issue