mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-30 04:15:45 +08:00
Xiaoyu SuandJunyan Chin
310c566148
* 重构文档结构：移除 docs 目录，调整文件组织结构 * Reorder "插件 SDK API" section in docs.json * Refactor and clarify various documentation sections * Refine warnings and info boxes across multiple docs * Refactor and simplify Japanese documentation content * Update package.json to include mintlify as a dependency and add pnpm-lock.yaml for dependency management * Update blog link and add description in docs.json --------- Co-authored-by: Junyan Chin <[email protected]>
56 lines
2.4 KiB
Plaintext
56 lines
2.4 KiB
Plaintext
---
|
|
title: "LangBot Plugins"
|
|
---
|
|
|
|
LangBot is composed of various internal components such as Large Language Model tools, commands, messaging platform adapters, LLM requesters, and more. To meet extensibility and flexibility requirements, we have implemented a production-grade plugin system.
|
|
|
|
Each plugin runs in an independent process, managed uniformly by the Plugin Runtime.
|
|
|
|
<img width="600" src="/images/zh/plugin/dev/plugin_system_arch.png" />
|
|
|
|
## Plugin Structure
|
|
|
|
Plugins can provide the following components based on their specific functionality:
|
|
|
|
- Event Handlers: Listen to events during pipeline execution and modify context or pipelines.
|
|
- Commands: Triggered by user command messages starting with `!` (or other configured prefixes).
|
|
- Tools: Called by LLMs during execution of LangBot's built-in Local Agent.
|
|
- Knowledge Retrievers: Used to retrieve relevant knowledge from external knowledge bases.
|
|
|
|
More component types will be supported for plugin implementation in the future.
|
|
|
|
## Installing Plugins
|
|
|
|
Currently supports uploading plugin packages and installing plugins from the plugin marketplace.
|
|
In LangBot's plugin management page, click the top-right corner to choose the installation method.
|
|
|
|
<img width="600" src="/images/zh/plugin/install_method.png" />
|
|
|
|
Click `Upload Local`, select `.lbpkg` files shared by others or downloaded from the Marketplace to install plugins.
|
|
|
|
Or click the Plugin Marketplace tab, select a plugin, and click install.
|
|
|
|
<img width="600" src="/images/zh/plugin/install_from_marketplace.png" />
|
|
|
|
After installing plugins, you need to select the plugin in your pipeline configuration page.
|
|
|
|
<img width="600" src="/images/zh/plugin/pipeline_extensions.png" />
|
|
|
|
## Plugin Management
|
|
|
|
### Plugin Configuration
|
|
|
|
Some plugins may require you to fill in specific configuration items (please refer to the plugin README instructions). Click on the plugin card to enter the plugin details page and obtain and input the required information as prompted.
|
|
|
|
<img width="600" src="/images/zh/plugin/plugin_config.png" />
|
|
|
|
### Updating Plugins
|
|
|
|
Only plugins installed from the plugin marketplace can be updated.
|
|
|
|
<img width="600" src="/images/zh/plugin/update_plugin.png" />
|
|
|
|
## Plugin Marketplace
|
|
|
|
The plugin marketplace can be accessed from LangBot's internal `Plugin Management` page, or you can visit the standalone site [LangBot Plugin Marketplace](https://space.langbot.app/market).
|