@flutchai/chat-contract

中文文档
0.1.9发布于 2026/11/03MITTypeScriptES Module零依赖近 30 天下载 2373

Flutch外部 API 的类型:代理引用,流,线程,历史,反应和上传. 没有运行时间代码 .

中文使用文档
文档目录3 节
  1. 里面有什么东西
  2. 识别用户
  3. 许可证

@flutchai/聊天合同

类型 小花头 外部 API : 向代理发送信件 (invoke, (中文(简体) ), stream, (中文(简体) ), cancel),列出线索,阅读历史,反应,文件上传和发送给用户的报告. 没有运行时间代码 .

npm install @flutchai/chat-contract
import type {
  AgentRequest,
  Message,
  StreamEvent,
  ThreadList,
} from "@flutchai/chat-contract";

const request: AgentRequest = {
  externalUserId: "customer-42", // your own id for the user
  content: { text: "Hello" },
};

大多数应用程序想要 @flutchai/chat-core (客户,SSE流媒体,谈话商店)或 @flutchai/chat-react (React UI),它依赖于此软件包. 当您在 TypeScript 中写入自己的客户端或代理服务器侧时直接使用它.

里面有什么东西

区域类型
请求AgentRequest, (中文(简体) ), UserRef, (中文(简体) ), RequestMetadata, (中文(简体) ), CancelRequest
信件Message, (中文(简体) ), MessageContent, (中文(简体) ), MessageInput, (中文(简体) ), ContentChain, (中文(简体) ), ReactionRequest
附录Attachment, (中文(简体) ), TypedAttachment, (中文(简体) ), AttachmentValueMap 每个附件类型( a)ImageValue, (中文(简体) ), Button, (中文(简体) ), CardValue, (...) (中文(简体) )
流线StreamEvent, (中文(简体) ), StreamEventMap, (中文(简体) ), StreamDelta, (中文(简体) ), EscalationReason
线索ThreadSummary, (中文(简体) ), ThreadList, (中文(简体) ), ThreadMessages, (中文(简体) ), Page
错误ApiErrorBody

未知的附件类型和新字段可以随时出现: 将合同视为打开并忽略您不承认的内容.

识别用户

每一份请求中,最终用户名均与 externalUserId (你自己的id,用户是先用创建的)或 userId (a Flustch 用户 id). 见 UserRef。 。 。 .

许可证

麻省理工学院

版本与发布记录

@flutchai/chat-contract 共发布 11 个版本,首次发布于 2026/10/21;过去 12 个月发布了 11 个版本。

版本发布日期距今
0.1.9latest2026/11/0312 天前
0.1.82026/11/0114 天前
0.1.72026/11/0114 天前
0.1.62026/11/0114 天前
0.1.52026/11/0114 天前
0.1.42026/10/3115 天前

关于 @flutchai/chat-contract 的常见问题

@flutchai/chat-contract 是什么?

Flutch外部 API 的类型:代理引用,流,线程,历史,反应和上传. 没有运行时间代码 .

如何安装 @flutchai/chat-contract?

在项目目录运行 npm install @flutchai/chat-contract,或使用 pnpm add / yarn add / bun add。

@flutchai/chat-contract 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@flutchai/chat-contract 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@flutchai/chat-contract 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@flutchai/chat-contract 可以商用吗?

@flutchai/chat-contract 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@flutchai/chat-contract 的下载量有多少?

根据 npm 官方下载统计,@flutchai/chat-contract 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,373 次,日均约 79 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@flutchai/chat-contract 还在维护吗?

最新版本 0.1.9 发布于 2026/11/03(12 天前);至今共发布 11 个版本,其中过去 12 个月发布了 11 个;首次发布于 2026/10/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。