Commit Graph
11 Commits
Author SHA1 Message Date
Junyan Qin 6966b8a67d sync zh doc changes to en and ja: fix tag formats, add new languages, update MCP sources 2026-03-30 20:05:29 +08:00
Junyan Qin 202d200814 docs: enhance plugin configuration documentation with preset options for string and select types 2026-03-29 00:32:14 +08:00
RockChinQ e41ede941c docs: fix PAT login instructions and add Japanese translation
- zh/en: update path to '账户设置 → 账户 → 个人访问令牌'
- ja: add PAT login as recommended method with device code fallback
2026-03-25 21:57:44 +08:00
Junyan Qin 932dd36abf docs(plugin): restore list_pipeline_knowledge_bases in Request API section (zh/en/ja) 2026-03-23 21:23:53 +08:00
Junyan Qin 04d7bb1436 fix(plugin): use Mintlify Tip component instead of ::: syntax 2026-03-23 21:21:43 +08:00
Junyan Qin ff512163de docs(plugin): remove deprecated pipeline-scoped KB API docs (zh/en/ja)
Remove list_pipeline_knowledge_bases and retrieve_knowledge from Request API
section as they are fully superseded by the global Knowledge Base APIs.
2026-03-23 21:18:49 +08:00
Junyan Qin 7a5ed2482d docs(plugin): add Knowledge Base API documentation (zh/en/ja)
Document the new global list_knowledge_bases() and retrieve_knowledge()
APIs in the LangBot API section of plugin common APIs docs.
2026-03-23 21:10:13 +08:00
huanghuoguoguo 94337e6c8e feat: add list kbengine and parser api (#89) 2026-03-12 22:15:48 +08:00
632c23e841 Docs/rag engine plugin architecture (#82)
* 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]>
2026-03-09 00:58:41 +08:00
Junyan Qin 93a73a7c70 Add Satori platform support in documentation, including features and usage instructions for Lucky Lilla Desktop 2026-02-23 15:26:50 +08:00
Xiaoyu SuandJunyan Chin 310c566148 refactor: migration to mintlify
* 重构文档结构:移除 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]>
2026-02-21 23:55:53 +08:00