@chat-adapter/ catalog 页面存档备份,存于互联网档案馆
npm 软件包 :
@chat-adapter/catalog
静态目录 聊天SDK 适配器: 列出的每个官方、供应商官方和社区适配器 聊天sdk.dev/适应器,带有npm软件包,维护者,以及支持的能力. 官方和供应商官方的条目还包括工厂出口、同行依赖以及建立这些实体所需的环境变量.
软件包没有依赖性,导入时没有适配码,因此可以在网站,构建脚本,设置屏幕,以及CLI中使用. 聊天-sdk.dev和 create-chat-sdk 都从它读.
联合国 聊天- sdk.dev/docs/适应器-目录 指南: vercel.com/kb/chat-sdk (英语)
安装
pnpm add @chat-adapter/catalog
使用量
列出适配器并检查它们的能力:
import { getFeatureSupport, listAdapters } from "@chat-adapter/catalog";
for (const adapter of listAdapters({ type: "platform" })) {
const streaming = getFeatureSupport(adapter, "streaming");
console.log(adapter.name, adapter.group, adapter.packageName, streaming);
}
listAdapters() 返回 talk-sdk.dev 中的官方和供应商官方适配器,然后列出社区适配器。 过 group (一组或数组)或 type 用于过滤.
阅读官方或供应商-官方适配器的设置要求:
import { getAdapter, getSecretEnvVars, listEnvVars } from "@chat-adapter/catalog";
const slack = getAdapter("slack");
console.log(slack.packageName, slack.factoryExport, slack.peerDeps);
const allVars = listEnvVars("slack").map((envVar) => envVar.key);
const secrets = getSecretEnvVars("slack").map((envVar) => envVar.key);
API 密码
| 导出 | 说明 |
|---|---|
listAdapters(options?) | 每个条目,包括社区适配器,均经过过滤 group 财务报告和审定财务报表 type |
getCatalogEntry(slug) | 任何通过弹道进入,或 undefined |
getAdapter(slug) | 官方或销售商官方通过喷口进入,或 undefined |
isAdapterSlug(slug) | 缩小字符串到 AdapterSlug (官方和供应商-官员) |
listPlatformAdapters() 编号 : listStateAdapters() | 官方和供应商官方条目按流星分类 |
getFeatureSupport(adapterOrSlug, key) | { status, label? } * 恢复未申报的能力 { status: "no" } |
getFeatureCategories(type) | 用于显示的能力密钥和标签 |
listEnvVars(slug) 编号 : getSecretEnvVars(slug) | 平整、去重复的 Env vars; 社区适配器空置 |
ADAPTERS 编号 : COMMUNITY_ADAPTERS | 被 sult 键入的条目 |
ADAPTER_NAMES | 官方和供应商官方流涕 |
PLATFORM_FEATURE_CATEGORIES 编号 : STATE_FEATURE_CATEGORIES | 每个显示标签的能力键 |
这个 chat/adapters 子路径 chat 套件是本套件中官方和供应商官方API被贬值后再出口.
添加适配器
每个适配器是一个文件在 src/adapters/<group>/<slug>.ts,注册于 src/adapters/index.ts,其中有一个文件页 apps/docs/content/adapters/<group>/。见 发布您的适配器 社区名单 列出供应商官方适配器 供应商正式上市.
AI 编码代理
如果您使用OpenAI Codex, Claude Code, 或 Cursor 等AI编码代理, 在写入代码前安装 Chat SDK 技能, 使其了解 SDK API, 适配器模式, 以及项目常规 .
npx skills add vercel/chat
关于可代理阅读的文件,见 聊天- sdk.dev/llms.txt (页数索引)或 聊天- sdk.dev/llms- full.txt (全文).
许可证
麻省理工学院