mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-29 20:05:25 +08:00
632c23e841
* docs: update wiki for RAG engine plugin architecture Replace KnowledgeRetriever component docs with RAGEngine across all three languages (zh/en/ja). Key changes: - Add new rag-engine.mdx component docs covering RAGEngine base class, creation_schema/retrieval_schema, capability declarations, lifecycle hooks, host RAG APIs, and complete code examples - Update knowledge base usage docs to reflect unified KB model (remove internal/external distinction, add RAG engine selection flow) - Update component list (add.mdx) and plugin intro to reference RAGEngine - Add RAG API section to plugin common APIs (invoke_embedding, vector_upsert/search/delete, get_rag_file_stream) - Update docs.json navigation to point to rag-engine pages Companion to LangBot PR #1995 and SDK PR #34. Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: sync with sdk * docs: update vector API docs with metadata filters, search_type, and documents support - Replace Warning tags about unimplemented filters with Info tags documenting canonical filter format (Chroma-style where syntax) and supported operators - Document search_type/query_text params for full-text and hybrid search - Document documents param for vector_upsert - Update RetrievalContext.filters description from reserved to active - Add filter usage examples (en/zh/ja) Co-Authored-By: Claude Opus 4.6 <[email protected]> * docs: enhance RAG Engine documentation across multiple languages - Expanded the description of the RAG Engine component to include bridging capabilities with advanced knowledge base services like Dify, RAGFlow, and FastGPT. - Clarified the `DOC_INGESTION` capability description, specifying conditions under which the declaration can be omitted. - Updated documentation in English, Japanese, and Chinese to ensure consistency and clarity. * docs: add instructions for show_if conditional rendering * docs: add Parser component documentation (zh/en/ja) Add Parser as a new component type in plugin docs. Parser extracts structured text from binary files (PDF, Word, etc.) before RAG engine ingestion. Includes manifest format, parse method API, data models (ParseContext/ParseResult/TextSection), RAGEngine integration via parsed_content, and cross-plugin invoke_parser API. Also add DOC_PARSING capability to RAG engine docs and parsed_content field to IngestionContext. Companion to SDK PR langbot-app/langbot-plugin-sdk#37 and LangBot PR langbot-app/LangBot#2000. Co-Authored-By: Claude Opus 4.6 <[email protected]> * docs: rename RAGEngine components to KnowledgeEngine * refactor: change rag engine to knowledge engine --------- Co-authored-by: Claude Opus 4.6 <[email protected]> Co-authored-by: Junyan Qin <[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 Engines: Manage document indexing and retrieval for 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).
|