Skip to main content

マニフェストファイルの修正

プラグインディレクトリ内のmanifest.yamlファイルは、プラグインの基本情報を宣言します。これはLangBot UIまたはプラグインマーケットプレイスのインターフェースに表示されます。
プラグインの多言語サポートはRFC 4646標準に従います。現在サポートされている言語は次のとおりです:
  • en_US 英語(必須)
  • zh_Hans 簡体字中国語
  • zh_Hant 繁体字中国語
  • ja_JP 日本語
  • vi_VN ベトナム語
  • th_TH タイ語
  • es_ES スペイン語

プラグイン設定項目フォーマット

manifest.yamlファイルのspec.configで宣言されたフィールドは、LangBotによってユーザーが入力するための設定項目フォームとしてレンダリングされます。プラグインは、SDKが提供するAPIを通じて、ユーザーが入力した設定項目を取得できます(後のセクションを参照)。 例えば:
設定項目でサポートされるタイプとフィールドは次のとおりです:

条件付きレンダリング (show_if)

すべてのタイプの設定項目は、show_if フィールドを使用した条件付きレンダリングをサポートしています。同じ(または関連する)フォーム内の他のフィールドの値に基づいて、現在のフィールドをレンダリングして表示するかどうかを決定できます。
注意: クロスフォームのカスケード関係(例:RAG エンジンの creation_schema 設定が retrieval_schema の値を読み取る、またはその逆)は、LangBot の最新フロントエンドでサポートされています。

type: string

文字列型。オプションでoptionsを設定してプリセット値をサポートできます。設定すると、入力フィールドの横にドロップダウンボタンが表示され、ユーザーがプリセット値をすばやく入力できます。自由入力も可能です。
プリセットオプション付き:

type: array[string]

文字列配列。

type: integer

整数型。

type: float

浮動小数点型。

type: boolean

ブール型。

type: select

ドロップダウンメニュー。optionsの設定が必要で、ドロップダウンメニューのオプションを表します。各オプションはlabelをメインテキストとして表示し、name(値)を小さなテキストで下に表示します。

type: prompt-editor

プロンプトエディター。パイプライン設定ページからプロンプトエディターを表示し、最終結果はOpenAIのmessages形式で表されます。

type: text

大きなテキスト入力。フロントエンドでtextareaとしてレンダリングされ、ユーザーが入力し、文字列としてプラグインに渡されます。

type: file

ファイルアップロード。最大10MBのファイルアップロードをサポートし、{"file_key": "xxxxx.xxx", "mimetype": "xxxxx"}形式でプラグインに渡されます。プラグインはget_config_file APIを使用してファイルの内容を取得できます。
プラグインでファイルを取得する:
一般的なMIMEタイプとファイル拡張子のリファレンス: MDNドキュメント

type: array[file]

複数ファイルアップロード。fileタイプと似ていますが、複数のファイルのアップロードをサポートし、[{"file_key": "xxxxx.xxx", "mimetype": "xxxxx"}]形式でプラグインに渡されます。
プラグインでファイルを取得する:

type: llm-model-selector

LLMモデルセレクター。設定されたLLMモデルを選択できるLLMモデルセレクターを表示し、最終結果はLLMモデルUUIDとして表されます。

type: bot-selector

Botセレクター。設定されたBotを選択できるBotセレクターを表示し、最終結果はBot UUIDとして表されます。
プラグインでBot UUIDを使用する:

type: tools-selector

ツールセレクター。登録済みのツール(プラグインツールおよび MCP ツール)を複数選択できるセレクターを表示します。最終結果はツール名の配列として表現されます。
プラグインで選択されたツール名を使用する:

次のステップ

このチュートリアルでは、プラグイン機能を段階的に完成させる方法を案内します。
  • コンポーネントの追加: プラグインコンポーネントはプラグインのコア機能ユニットです。必要に応じてコンポーネントを追加できます。