mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-07-09 04:44:49 +08:00
### 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" /> ---------
136 lines
4.6 KiB
Python
136 lines
4.6 KiB
Python
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import logging
|
|
from dataclasses import dataclass
|
|
from typing import Optional
|
|
|
|
import discord
|
|
|
|
from ..core.base import Channel, IncomingMessage, OutgoingMessage
|
|
from ..core.registry import register_channel
|
|
|
|
LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
@dataclass
|
|
class DiscordAccount:
|
|
account_id: str
|
|
token: str
|
|
|
|
|
|
def _chat_type(channel: discord.abc.Messageable) -> str:
|
|
if isinstance(channel, discord.DMChannel):
|
|
return "p2p"
|
|
if isinstance(channel, discord.Thread):
|
|
return "thread"
|
|
if isinstance(channel, (discord.TextChannel, discord.VoiceChannel, discord.StageChannel)):
|
|
return "group"
|
|
return type(channel).__name__
|
|
|
|
|
|
class DiscordChannel(Channel):
|
|
channel_id = "discord"
|
|
|
|
def __init__(self, account: DiscordAccount) -> None:
|
|
super().__init__()
|
|
self.account = account
|
|
self.account_id = account.account_id
|
|
intents = discord.Intents.default()
|
|
# Message Content is a privileged intent; must also be enabled in the
|
|
# Developer Portal under the application's Bot page.
|
|
intents.message_content = True
|
|
self._client = discord.Client(intents=intents)
|
|
self._run_task: Optional[asyncio.Task] = None
|
|
self._register_handlers()
|
|
|
|
def _register_handlers(self) -> None:
|
|
@self._client.event
|
|
async def on_ready() -> None:
|
|
try:
|
|
user = self._client.user
|
|
LOGGER.info(
|
|
"[discord:%s] connected as %s (id=%s)",
|
|
self.account_id,
|
|
user,
|
|
user.id if user else "unknown",
|
|
)
|
|
except Exception:
|
|
LOGGER.error("[discord:%s] on_ready error", self.account_id, exc_info=True)
|
|
|
|
@self._client.event
|
|
async def on_message(message: discord.Message) -> None:
|
|
try:
|
|
if message.author.bot:
|
|
return
|
|
me = self._client.user
|
|
if me is not None and message.author.id == me.id:
|
|
return
|
|
incoming = IncomingMessage(
|
|
channel=self.channel_id,
|
|
account_id=self.account_id,
|
|
chat_id=str(message.channel.id),
|
|
chat_type=_chat_type(message.channel),
|
|
message_id=str(message.id),
|
|
sender_id=str(message.author.id),
|
|
text=message.content or "",
|
|
raw=message,
|
|
)
|
|
await self._dispatch(incoming)
|
|
except Exception:
|
|
LOGGER.error("[discord:%s] inbound message handling error", self.account_id, exc_info=True)
|
|
|
|
async def start(self) -> None:
|
|
LOGGER.info("[discord:%s] starting gateway client", self.account_id)
|
|
self._run_task = asyncio.create_task(self._client.start(self.account.token))
|
|
|
|
async def stop(self) -> None:
|
|
if not self._client.is_closed():
|
|
await self._client.close()
|
|
if self._run_task and not self._run_task.done():
|
|
try:
|
|
await self._run_task
|
|
except (asyncio.CancelledError, Exception):
|
|
pass
|
|
|
|
async def send(self, message: OutgoingMessage) -> None:
|
|
try:
|
|
channel_id = int(message.chat_id)
|
|
except (TypeError, ValueError):
|
|
LOGGER.error("[discord:%s] invalid chat_id: %r", self.account_id, message.chat_id)
|
|
return
|
|
|
|
target = self._client.get_channel(channel_id)
|
|
if target is None:
|
|
try:
|
|
target = await self._client.fetch_channel(channel_id)
|
|
except discord.HTTPException as err:
|
|
LOGGER.error("[discord:%s] fetch_channel failed: %s", self.account_id, err)
|
|
return
|
|
|
|
reference = None
|
|
if message.reply_to_message_id:
|
|
try:
|
|
reference = discord.MessageReference(
|
|
message_id=int(message.reply_to_message_id),
|
|
channel_id=channel_id,
|
|
fail_if_not_exists=False,
|
|
)
|
|
except (TypeError, ValueError):
|
|
reference = None
|
|
|
|
try:
|
|
await target.send(message.text, reference=reference)
|
|
except discord.HTTPException as err:
|
|
LOGGER.error("[discord:%s] send failed: %s", self.account_id, err)
|
|
|
|
|
|
def _build(account_id: str, cfg: dict) -> Channel:
|
|
token = cfg.get("token")
|
|
if not token:
|
|
raise ValueError(f"discord account '{account_id}' is missing token")
|
|
return DiscordChannel(DiscordAccount(account_id=account_id, token=str(token)))
|
|
|
|
|
|
register_channel("discord", _build)
|