Files
ragflow/api/channels/core/registry.py
Kevin Hu b5a426e6e0 Feat: chat channels — connect assistants to external messaging bots (#15850)
### What problem does this PR solve?

#15844

Adds a **Chat channels** capability so a RAGFlow assistant (Dialog) can
be exposed as a bot on external messaging platforms (Feishu/Lark,
Discord, Telegram, Slack, WeCom, LINE, etc.). An admin configures a bot
in the UI, connects it to an assistant, and inbound messages are
answered from that assistant's knowledge base — replies are delivered
back on the channel.

**Feishu/Lark is implemented and tested end-to-end.** Discord, Telegram,
LINE, and WeCom are scaffolded against the same interface; the remaining
listed channels are tracked as follow-ups.

### Design

**Backend**
- New `chat_channel` table (`tenant_id`, `name`, `channel`, `config`
JSON holding `{credential: {...}}`, `dialog_id`, `status`) +
`ChatChannelService` and RESTful CRUD under `/api/v1/chat_channels`.
- Channel framework under `api/channels/`: a `core` registry +
per-channel packages that self-register a builder and implement a common
`Channel` interface (`start`/`stop`/`send` + inbound normalization) over
`IncomingMessage`/`OutgoingMessage`.
- Embedded **reconcile loop** in `ragflow_server`
(`api/channels/bootstrap.py`): loads enabled bots, and
starts/stops/restarts them as rows change (no server restart needed).
Inbound messages run the connected dialog via the non-streaming
completion path, keeping per-end-user conversation history.
- Missing optional channel SDKs degrade gracefully (channel skipped with
a warning; others unaffected). Channel-level errors are logged, not
crashed.
- Feishu's WebSocket client runs in a dedicated thread with its own
event loop to avoid cross-loop/contextvars conflicts with the channel
runtime.

**Frontend**
- **Settings → Chat channels** panel: available-channels grid +
configured-bots list with add/edit/delete and a **Connect assistant**
popup that binds a bot to a dialog.
- Brand icons via simple-icons / reused shared data-source assets, with
colored fallbacks for brands not available.
- Route, sidebar entry, i18n (en/zh), and a top-nav segment-boundary fix
so the settings page no longer highlights the Chat tab.

### Type of change

- [x] New Feature (non-breaking change which adds functionality)

### Notes
- DB: new `chat_channel` table is auto-created; `chat_channel.dialog_id`
is also covered by a `migrate_db` `alter_db_add_column` for existing
installs.
- Channel SDKs (`lark-oapi`, `discord.py`, `python-telegram-bot`,
`line-bot-sdk`, `wechatpy`, `aiohttp`) added to dependencies.
- Screenshots / per-channel credential docs to follow.

<img width="1338" height="1290" alt="Image"
src="https://github.com/user-attachments/assets/042cb2f9-0dad-4e6a-bcf7-43ced4bbd704"
/>

<img width="1344" height="738" alt="Image"
src="https://github.com/user-attachments/assets/373cd08e-ec40-4c67-9c51-4d948b1ba617"
/>

<img width="672" height="887" alt="Image"
src="https://github.com/user-attachments/assets/5a34953f-a9a3-4c1e-869e-5eff0dc64c84"
/>

---------
2026-06-12 18:21:30 +08:00

48 lines
1.6 KiB
Python

from __future__ import annotations
import logging
from typing import Callable, Dict, List
from .base import Channel
LOGGER = logging.getLogger(__name__)
ChannelBuilder = Callable[[str, dict], Channel]
_BUILDERS: Dict[str, ChannelBuilder] = {}
def register_channel(name: str, builder: ChannelBuilder) -> None:
_BUILDERS[name] = builder
def registered_channel_ids() -> List[str]:
return sorted(_BUILDERS)
def build_channels(config: dict) -> List[Channel]:
"""Walk config.channels.<name>.accounts.<id> and construct one Channel per account."""
instances: List[Channel] = []
channels_cfg = config.get("channels") or {}
for name, raw in channels_cfg.items():
if not isinstance(raw, dict) or raw.get("enabled") is False:
continue
builder = _BUILDERS.get(name)
if builder is None:
LOGGER.warning("no builder registered for channel '%s'; skipping", name)
continue
accounts = raw.get("accounts") or {}
if not accounts:
# Allow a flat single-account config without an `accounts:` block.
accounts = {"default": {k: v for k, v in raw.items() if k != "accounts"}}
shared = {k: v for k, v in raw.items() if k not in ("accounts", "default_account")}
for account_id, account_cfg in accounts.items():
if not isinstance(account_cfg, dict):
continue
if account_cfg.get("enabled") is False:
continue
merged = {**shared, **account_cfg}
instances.append(builder(str(account_id), merged))
return instances