プラグイン設定情報の完成
目次
マニフェストファイルの修正
プラグインディレクトリ内のmanifest.yamlファイルは、プラグインの基本情報を宣言します。これはLangBot UIまたはプラグインマーケットプレイスのインターフェースに表示されます。
apiVersion: v1 # 変更しないでください
kind: Plugin # 変更しないでください
metadata:
author: RockChinQ # 作成者、正規表現^[a-zA-Z0-9_-]+$に一致する必要があります
name: HelloPlugin # プラグイン名、プラグインを区別するために使用、正規表現^[a-zA-Z0-9-]+$に一致する必要があります
repository: 'https://github.com/langbot-app/HelloPlugin' # プラグインリポジトリURL
version: 0.1.0 # プラグインバージョン
description:
en_US: 'Hello LangBot Plugin' # プラグイン説明、多言語対応
zh_Hans: 'Hello LangBot Plugin'
label:
en_US: HelloPlugin # プラグインラベル、インターフェースに表示、多言語対応
zh_Hans: HelloPlugin
icon: assets/icon.svg # プラグインアイコン、デフォルトはassets/icon.svg、さまざまな画像形式に置き換え可能
spec:
config: [] # プラグイン設定項目フォーマット
components: {} # プラグインコンポーネントリスト、手動で変更する必要はありません
execution:
python:
path: main.py # 変更しないでください
attr: HelloPlugin # 変更しないでくださいプラグインの多言語サポートはRFC 4646標準に従います。現在サポートされている言語は次のとおりです:
en_US英語zh_Hans簡体字中国語zh_Hant繁体字中国語ja_JP日本語
プラグイン設定項目フォーマット
manifest.yamlファイルのspec.configで宣言されたフィールドは、LangBotによってユーザーが入力するための設定項目フォームとしてレンダリングされます。プラグインは、SDKが提供するAPIを通じて、ユーザーが入力した設定項目を取得できます(後のセクションを参照)。
例えば:
spec:
config:
- name: github_token # 必須; 設定項目名、プラグイン内での取得に使用
type: string # 必須; 設定項目タイプ、string、integer、float、boolean、select、prompt-editor、llm-model-selector、bot-selectorなどをサポート
label: # 必須; 設定項目表示名、多言語サポート。言語コードはRFC 4646標準に従います。
en_US: Github Token
zh_Hans: Github Token
description: # 設定項目説明、多言語サポート。オプション。
en_US: Image downloading requires a Github token
zh_Hans: 如果不填的話、图片可能會下載失败
default: '' # 設定項目のデフォルト値、オプション。
required: false # 設定項目が必須かどうか、オプション。
- name: mode
type: select
...設定項目でサポートされるタイプとフィールドは次のとおりです:
type: string
文字列型。
- name: api_key
type: string
...type: array[string]
文字列配列。
- name: tags
type: array[string]
...type: integer
整数型。
- name: progress
type: integer
...type: float
浮動小数点型。
- name: temperature
type: float
...type: boolean
ブール型。
- name: is_enabled
type: boolean
...type: select
ドロップダウンメニュー。optionsの設定が必要で、ドロップダウンメニューのオプションを表します。
- name: mode
type: select
options: # ドロップダウンオプション、多言語サポート。
- name: mode1 # 値
label: # 表示名、多言語サポート。
en_US: Mode 1
zh_Hans: 模式 1
- name: mode2
label: # 表示名、多言語サポート。
en_US: Mode 2
zh_Hans: 模式 2
...type: prompt-editor
プロンプトエディター。パイプライン設定ページからプロンプトエディターを表示し、最終結果はOpenAIのmessages形式で表されます。
- name: prompt
type: prompt-editor
...type: text
大きなテキスト入力。フロントエンドでtextareaとしてレンダリングされ、ユーザーが入力し、文字列としてプラグインに渡されます。
- name: prompt
type: text
...type: file
ファイルアップロード。最大10MBのファイルアップロードをサポートし、{"file_key": "xxxxx.xxx", "mimetype": "xxxxx"}形式でプラグインに渡されます。プラグインはget_config_file APIを使用してファイルの内容を取得できます。
- name: config_file
type: file
accept: 'application/json' # オプション、受け入れるファイルMIMEタイプを指定
...プラグインでファイルを取得する:
# 設定からファイル情報を取得
file_config = self.get_config()['config_file']
file_key = file_config['file_key']
mimetype = file_config['mimetype']
# 出力例: {'file_input': {'file_key': 'plugin_config_d2234fd802054faf80babe0679a97fa9.json', 'mimetype': 'application/json'}}
print(file_config)
# ファイルの内容を取得
file_bytes = await self.get_config_file(file_key)INFO
一般的なMIMEタイプとファイル拡張子のリファレンス: MDNドキュメント
type: array[file]
複数ファイルアップロード。fileタイプと似ていますが、複数のファイルのアップロードをサポートし、[{"file_key": "xxxxx.xxx", "mimetype": "xxxxx"}]形式でプラグインに渡されます。
- name: resource_files
type: array[file]
accept: 'image/*' # オプション、受け入れるファイルMIMEタイプを指定
...プラグインでファイルを取得する:
# 設定からファイルリストを取得
files_config = self.get_config()['resource_files']
for file_config in files_config:
file_key = file_config['file_key']
mimetype = file_config['mimetype']
# ファイルの内容を取得
file_bytes = await self.get_config_file(file_key)type: llm-model-selector
LLMモデルセレクター。設定されたLLMモデルを選択できるLLMモデルセレクターを表示し、最終結果はLLMモデルUUIDとして表されます。
- name: model
type: llm-model-selector
...type: bot-selector
Botセレクター。設定されたBotを選択できるBotセレクターを表示し、最終結果はBot UUIDとして表されます。
- name: bot
type: bot-selector
...プラグインでBot UUIDを使用する:
# 設定からBot UUIDを取得
bot_uuid = self.get_config()['bot']
print(bot_uuid) # 出力: '550e8400-e29b-41d4-a716-446655440000'次のステップ
このチュートリアルでは、プラグイン機能を段階的に完成させる方法を案内します。
- コンポーネントの追加: プラグインコンポーネントはプラグインのコア機能ユニットです。必要に応じてコンポーネントを追加できます。