Plugin info by Manifest¶
Note: ⚠️ このドキュメントは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"
構造¶
プラグインのバージョン。
プラグインタイプ。現在はpluginのみサポートされており、将来的にbundleがサポートされる予定です。
作成者。Marketplaceでは組織名として定義されます。
多言語名。
作成時刻。Marketplaceでは現在時刻より後であってはなりません。
アイコンパス。
申請するリソース。
最大メモリ使用量。主にSaaS上のAWS Lambdaリソース申請に関連します。単位はバイトです。
権限申請。
ツールの逆呼び出し権限。
ツール権限を有効にするかどうか。
モデルの逆呼び出し権限。
モデル権限を有効にするかどうか。
大規模言語モデル権限を有効にするかどうか。
テキスト埋め込みモデル権限を有効にするかどうか。
rerankモデル権限を有効にするかどうか。
テキスト読み上げモデル権限を有効にするかどうか。
音声テキスト変換モデル権限を有効にするかどうか。
コンテンツモデレーションモデル権限を有効にするかどうか。
ノードの逆呼び出し権限。
ノード権限を有効にするかどうか。
`endpoint`を登録する権限。
endpoint権限を有効にするかどうか。
`app`の逆呼び出し権限。
app権限を有効にするかどうか。
永続ストレージを申請する権限。
ストレージ権限を有効にするかどうか。
許可される最大永続メモリサイズ。単位はバイトです。
プラグインによって拡張される特定の機能のyamlファイルのリスト。プラグインパッケージ内の絶対パスです。例えば、モデルを拡張する必要がある場合、openai.yamlのようなファイルを定義し、ここにファイルパスを記入する必要があります。このパスにファイルが実際に存在しない場合、パッケージングは失敗します。
Warning:
ツールとモデルを同時に拡張することは許可されていません。Warning:
拡張がないことは許可されていません。Warning:
モデルとEndpointsを同時に拡張することは許可されていません。Warning:
現在、各タイプの拡張では1つのプロバイダーのみがサポートされています。
[ツール](/ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin)プロバイダーのプラグイン拡張。
[モデル](/ja/develop-plugin/features-and-specs/plugin-types/model-designing-rules)プロバイダーのプラグイン拡張。
[Endpoints](/ja/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin)プロバイダーのプラグイン拡張。
[エージェント戦略](/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation)プロバイダーのプラグイン拡張。
プラグインのメタデータ。
`manifest`フォーマットバージョン。初期バージョンは`0.0.1`です。
サポートされるアーキテクチャ。現在は`amd64`と`arm64`のみサポートされています。
ランタイム設定。
プログラミング言語。現在はPythonのみサポートされています。
言語バージョン。現在は`3.12`のみサポートされています。
プログラムエントリポイント。Pythonでは`main`である必要があります。
プラグインのプライバシーポリシーファイルの相対パスまたはURLを指定します。例："./privacy.md"または"https://your-web/privacy"。プラグインをFlexAI Marketplaceに掲載する予定がある場合、明確なユーザーデータの使用とプライバシーに関する声明を提供するためにこのフィールドは必須です。詳細な記入ガイドラインについては、プラグインプライバシーデータ保護ガイドラインを参照してください。
{/ Contributing Section DO NOT edit this section! It will be automatically generated by the script. /}