Files
LangBot/docs/ja/plugin/dev/components/add.md
T
2025-12-12 17:55:27 +08:00

74 lines
2.5 KiB
Markdown

# コンポーネントの追加
プラグインは、LangBotにさまざまな機能を提供する1つ以上のコンポーネントで構成されています。現在サポートされているコンポーネントタイプには次のものがあります:
- イベントリスナー(EventListener): パイプライン実行中のイベントをリッスンし、コンテキストやパイプラインを変更します。
- コマンド(Command): `!`(または他の設定されたプレフィックス)で始まるユーザーコマンドメッセージによってトリガーされます。
- ツール(Tool): LangBotの組み込みLocal Agentの実行中にLLMによって呼び出されます。
- ナレッジリトリーバー(KnowledgeRetriever): LangBotに外部ナレッジベース検索機能を提供し、さまざまなRAGシステムとの統合をサポートします。
## コンポーネントの追加
プラグインディレクトリでコマンドを実行します:
```bash
lbp comp <component_type>
```
例えば、イベントリスナーを追加する場合:
```bash
lbp comp EventListener
```
プロンプトに従って、コンポーネント設定(ある場合)を入力します。
```bash
➜ HelloPlugin > lbp comp EventListener
Generating component EventListener...
Component EventListener generated successfully.
組件 EventListener 生成成功。
➜ HelloPlugin >
```
:::info
CLIはプラグインディレクトリに`components`ディレクトリを生成し、その中に対応するコンポーネントディレクトリを作成します。
```
.
├── assets
│ └── icon.svg
├── components
│ ├── __init__.py
│ └── event_listener
│ ├── __init__.py
│ ├── default.py
│ └── default.yaml
├── main.py
├── manifest.yaml
├── README.md
└── requirements.txt
```
同時に、プラグインの`manifest.yaml`にコンポーネント検出設定が追加されます:
```yaml
...
components:
EventListener:
fromDirs:
- path: components/event_listener/
...
```
コンポーネントを削除するには、対応する情報を手動で削除できます。
:::
## コンポーネントタイプ
各コンポーネントの詳細な使用方法については、次を参照してください:
- [EventListener](./event-listener.md)
- [Command](./command.md)
- [Tool](./tool.md)
- [KnowledgeRetriever](./knowledge-retriever.md)