# 聊天SDK 统一的 TypeScript SDK，用于跨 Slack、Teams、Google Chat、Discord、GitHub 和 Linear 构建聊天机器人。机器人逻辑编写一次，随处部署。 ## 重要：阅读捆绑文档 `chat` 包附带了 `node_modules/chat/docs/` 和 TypeScript 源类型中的完整文档。 **在编写代码之前请务必阅读这些内容：** node_modules/chat/docs/ # 完整文档（MDX 文件） node_modules/chat/dist/ # 内置类型（.d.ts 文件）根据任务需要阅读的关键文档： * `docs/getting-started.mdx` — 设置指南 * `docs/usage.mdx` — 事件处理程序、线程、消息、通道 * `docs/streaming.mdx` — 使用 AI SDK 进行 AI 流式传输 * `docs/cards.mdx` — JSX 交互式卡片 * `docs/actions.mdx` — 按钮/下拉菜单处理程序 * `docs/modals.mdx` — 表单对话框（仅限 Slack） * `docs/adapters.mdx` — 特定于平台的适配器设置 * `docs/state.mdx` — 状态适配器配置（Redis、ioredis、PostgreSQL、内存）另请阅读“node_modules/chat/dist/”中的 TypeScript 类型，以了解完整的 API 表面。 ## 快速开始从“聊天”导入{聊天}；从“@chat-adapter/slack”导入{createSlackAdapter}；从“@chat-adapter/state-redis”导入{createRedisState}； const bot = 新聊天（{ 用户名：“mybot”，适配器：{ 松弛：createSlackAdapter({ botToken：process.env.SLACK_BOT_TOKEN！，签名秘密：process.env.SLACK_SIGNING_SECRET！， }), }, 状态：createRedisState({ url: process.env.REDIS_URL! }), }); bot.onNewMention（异步（线程）=> { 等待线程.subscribe(); wait thread.post(“你好！我正在听这个线程。”); }); bot.onSubscribedMessage（异步（线程，消息）=> { wait thread.post(`你说：${message.text}`); }); ## 核心概念 * **聊天** — 主要入口点，协调适配器和路由事件 * **适配器** — 特定于平台（Slack、Teams、GChat、Discord、GitHub、Linear） * **State** — 可插入持久性（Redis 或 PostgreSQL 用于生产，内存用于开发） * **Thread** — 与 `post()`、`schedule()`、`subscribe()`、`startTyping()` 的对话线程 * **消息** — 规范化格式，包括 `text`、`formatted` (mdast AST)、`raw` * **频道** — 话题容器，支持列表和发布 ## 事件处理程序处理程序 |触发 ---|--- `onNewMention` |在取消订阅的线程中@提及机器人 `onSubscribedMessage` |订阅线程中的任何消息 `onNewMessage（正则表达式）` |与取消订阅线程中的模式匹配的消息 `onSlashCommand("/cmd")` |斜杠命令调用 `onReaction(表情符号)` |添加/删除了表情符号反应 `onAction(actionId)` |按钮点击和下拉选择 `onAssistantThreadStarted` | Slack Assistants API 线程已打开 `onAppHomeOpened` | Slack 应用程序主页选项卡已打开 ## 流媒体将任何 `AsyncIterable` 传递给 `thread.post()`。与 AI SDK 的“textStream”配合使用：从“ai”导入{ToolLoopAgent}； const agent = new ToolLoopAgent({ model: "anthropic/claude-4.5-sonnet" }); bot.onNewMention（异步（线程，消息）=> { const result = wait agent.stream({ 提示: message.text }); 等待线程.post(结果.textStream); }); ## 卡牌 (JSX) 在 tsconfig.json 中设置 `jsxImportSource: "chat"`组件：`Card`、`CardText`、`Button`、`Actions`、`Fields`、`Field`、`Select`、`SelectOption`、`Image`、`Divider`、`LinkButton`、`Section`、`RadioSelect`。等待线程.post( <卡标题=“订单#1234”> 您的订单已收到！ <行动> ）； ## 套餐套餐 |目的 ---|--- `聊天` |核心SDK `@chat-adapter/slack` |松弛 `@chat-adapter/teams` |微软团队 `@chat-adapter/gchat` |谷歌聊天 `@chat-adapter/discord` |不和谐 `@chat-adapter/github` | GitHub 问题 `@chat-adapter/线性` |线性问题 `@chat-adapter/state-redis` | Redis 状态（生产） `@chat-adapter/state-ioredis` | ioredis 状态（替代） `@chat-adapter/state-pg` | PostgreSQL 状态（生产） `@chat-adapter/状态内存` |内存状态（开发） ## 变更集（发布流程）此 monorepo 使用 [Changesets]() 进行版本控制和变更日志。每个更改包行为的 PR 都必须包含变更集。 pnpm 变更集 # → 选择受影响的软件包（例如@chat-adapter/slack、chat） # → 选择凹凸类型：补丁（修复）、次要（功能）、主要（破坏） # → 为变更日志写一个简短的摘要这会在 `.changeset/` 中创建一个文件 - 使用 PR 提交它。当合并到“main”时，Changesets GitHub Action 会打开一个“版本包”PR 来更改版本并更新变更日志。合并该 PR 发布到 npm。 ## 构建自定义适配器要创建社区或供应商适配器，请从“chat”实现“Adapter”接口并阅读： * `docs/contributing/building.mdx` — 完整的分步指南（使用 Matrix 适配器作为示例） * `docs/contributing/testing.mdx` — 测试你的适配器 * `docs/contributing/publishing.mdx` — npm 命名约定和发布适配器必须实现“handleWebhook”、“parseMessage”、“postMessage”、“editMessage”、“deleteMessage”、线程 ID 编码/解码和“FormatConverter”（从“chat”扩展“BaseFormatConverter”）。对错误类和消息实用程序使用“@chat-adapter/shared”。 ## Webhook 设置每个适配器通过“bot.webhooks.{platform}”公开一个 Webhook 处理程序。将它们连接到 HTTP 框架的路由（例如 Next.js API 路由、Hono、Express）。

聊天软件开发工具包

包含技能