Files
ragflow/api/db/services/chat_channel_service.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

83 lines
2.8 KiB
Python

#
# Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import logging
from peewee import JOIN
from api.db.db_models import DB, ChatChannel, Dialog
from api.db.services.common_service import CommonService
LOGGER = logging.getLogger(__name__)
class ChatChannelService(CommonService):
model = ChatChannel
@classmethod
@DB.connection_context()
def list(cls, tenant_id):
"""List a tenant's chat channel bots with their connected dialog (no credentials)."""
fields = [
cls.model.id,
cls.model.name,
cls.model.channel,
cls.model.dialog_id,
cls.model.status,
Dialog.name.alias("dialog_name"),
]
return list(
cls.model.select(*fields)
.join(
Dialog,
join_type=JOIN.LEFT_OUTER,
on=(Dialog.id == cls.model.dialog_id),
)
.where(cls.model.tenant_id == tenant_id)
.order_by(cls.model.create_time.desc())
.dicts()
)
@classmethod
@DB.connection_context()
def list_active(cls):
"""Return all enabled chat channel bots across tenants (with credentials)."""
return list(cls.model.select().where(cls.model.status == "1"))
@classmethod
@DB.connection_context()
def accessible(cls, channel_id: str, user_id: str) -> bool:
"""Return whether the user can access the chat channel's tenant."""
e, channel = cls.get_by_id(channel_id)
if not e:
LOGGER.warning("chat channel access denied: not found channel_id=%s user_id=%s", channel_id, user_id)
return False
if channel.tenant_id == user_id:
return True
from api.db.services.user_service import TenantService
joined_tenants = TenantService.get_joined_tenants_by_user_id(user_id)
has_access = any(tenant["tenant_id"] == channel.tenant_id for tenant in joined_tenants)
if not has_access:
LOGGER.warning(
"chat channel access denied: tenant mismatch channel_id=%s user_id=%s tenant_id=%s",
channel_id,
user_id,
channel.tenant_id,
)
return has_access