@godspeedai/cognate-client

中文文档
0.10.0发布于 2026/11/16Apache-2.0ES Module构建来源已验证近 30 天下载 3723

无头客户端:运行,重新连接事件订阅,衍生运行状态,共享预测,续作,前端能力,文物. 无反应(参见§25.1).

中文使用文档
文档目录6 节
  1. 安装
  2. 快开始
  3. 客户所覆盖的
  4. 限制
  5. 相关软件包
  6. 许可证

@ godspideai/ cognate- 客户端

无头的 Cognate 客户端: 启动和监视运行, 解决批准, 写入共享状态, 服务 并读取预测数——任何 RuntimeService,正在处理中或 遥控 所有客户端状态都来源于耐久事件,因此它能活下来再连接,并且可以 从零开始重建。 框架中性:无反应(反应绑定在 @godspeedai/cognate-react) (中文(简体) ).

何时使用此软件包 : 任何前端,服务, 或脚本, 谈论一个Cognate运行时间. 对于浏览器 UI, 将其与 React 绑定对齐; 对于远程运行时间, 将其交给 运输支持 RuntimeService 例如来自 @godspeedai/cognate-protocol-connect。 。 。 .

安装

bun add @godspeedai/cognate-client

要求数 阿宝 >= 1.4.0.

快开始

与进程内参考运行时间相对应的全程往返——同一流量工作不变 反对远程服务:

import { createClient } from "@godspeedai/cognate-client";
import { alice } from "@godspeedai/cognate-runtime-api/conformance"; // a ready-made caller
import type { AgentDefinition } from "@godspeedai/cognate-runtime-api";
import { createRuntime } from "@godspeedai/cognate-runtime-bun";

const refundAgent: AgentDefinition = {
  id: "agent.refund",
  version: "1.0.0",
  async run(input, ctx) {
    const { amount } = input as { amount: number };
    const decision = (await ctx.waitFor("approve", {
      type: "refund-approval",
      condition: { kind: "human_approval" },
      payload: { amount },
    })) as { approved: boolean };
    return { amount, approved: decision.approved };
  },
};

const runtime = await createRuntime({
  store: ":memory:",
  policy: { authorize: () => ({ allow: true, policyId: "p", reason: "ok" }) },
  actions: { authorize: () => ({ allow: true, reason: "ok" }) },
  agents: [refundAgent],
});

// `caller` is the identity established by your transport's authenticator — never a request body.
const client = createClient({ service: runtime.service, caller: alice });

const run = await client.startRun("agent.refund", { amount: 75 });

async function waitUntil<T>(read: () => T, ok: (v: T) => boolean): Promise<T> {
  for (;;) {
    const value = read();
    if (ok(value)) return value;
    await Bun.sleep(10);
  }
}

// `run(id)` is a live, reactive view derived only from the run's durable events.
const waiting = await waitUntil(
  () => client.run(run.runId).get(),
  (s) => s.openContinuations.length === 1,
);
const approval = waiting.openContinuations[0]!;

await client.resolveContinuation(approval.id, "resume", { approved: true });

const done = await waitUntil(
  () => client.run(run.runId).get(),
  (s) => s.status === "completed",
);
console.log(done.output); // { amount: 75, approved: true }

await client.close();
await runtime.close();

在适合你的地方订阅投票:

const stop = client.run(runId).subscribe((state) => {
  console.log(state.status, state.text, state.state);
});
// state.text accumulates message.delta events; state.state folds state.changed
// snapshots and RFC 6902 patches; stop() unsubscribes.

客户所覆盖的

  • 运行 —— 说 startRun(agent, input, { correlationId?, state? }), (中文(简体) ), cancelRun(runId, reason),以及 run(runId)(单位:千美元) Readable<RunState> 与 status累积 text,折叠共享 state, (中文(简体) ), openContinuations, (中文(简体) ), artifacts, (中文(简体) ), output,以及 error。 。 。 .
  • 共享状态, 双向 —— 说 startRun(..., { state }) 种子一跑的初始状态; updateState(runId, update) 在运行等待( snapshot 或 JSON 补丁) 时写入, 代理 通过自己的状态来观察它. threadSharedState(threadId) 编号 : updateThreadSharedState 对线程中每跑一次共享的持久状态也做同样的事情.
  • 重新连接的事件流 —— 说 subscribe({ afterPosition?, runId? }, listener) 从 断开后最后一个已交付位置:没有空白,没有重复. status 报告 connecting 编号 : live 编号 : reconnecting 编号 : closed (后退默认为50 ms翻倍为2 s).
  • 前端能力 —— 说 provideCapability("map.focus", handler) 执行打开 frontend_capability 继续将能力命名并解决它们以运行 代理方为 invokeFrontend 从 @godspeedai/cognate-runtime-api。 。 。 . offerCapability(offer, handler) 进一步公布这一能力,作为对 一个特工,自动续签,直到你解除注册.
  • 继续、预测、引用、文物 —— 说 resolveContinuation(id, "resume" | "cancel", input), (中文(简体) ), projection(name) 联合国 Readable 随着事件的发生而更新 refresh() 供按需重新阅读, invoke(capability, input) 通过运行时间 授权路径,以及 artifact(artifactId) 以获取字节.
  • 清理 —— 说 close() 停止流并取消发布此客户端的任何远程报价 .

限制

  • 衍生出,从不权威. 客户展示的都是租户耐用品 事件;运行时间及其商店拥有真理. 读取的投影可能会短暂地延后 生产它——呼叫 refresh() 当你需要最新读取.
  • 这里没有认证 . 客户要一个 Caller 在别处定居的人 运输的验证器;它从不发送证书本身.
  • 没有反应. 这个 Readable 接口( e)get编号 :subscribe故意使框架中立; 使用情况 @godspeedai/cognate-react 页:1 反应19装订.

许可证

阿帕奇 - 2.0

版本与发布记录

@godspeedai/cognate-client 共发布 20 个版本,首次发布于 2026/10/09;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.10.0latest2026/11/16今天
0.9.22026/11/152 天前
0.9.12026/11/143 天前
0.9.02026/11/0610 天前
0.8.02026/10/2720 天前
0.7.12026/10/2523 天前

关于 @godspeedai/cognate-client 的常见问题

@godspeedai/cognate-client 是什么?

无头客户端:运行,重新连接事件订阅,衍生运行状态,共享预测,续作,前端能力,文物. 无反应(参见§25.1).

如何安装 @godspeedai/cognate-client?

在项目目录运行 npm install @godspeedai/cognate-client,或使用 pnpm add / yarn add / bun add。

@godspeedai/cognate-client 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/godspeedai__cognate-client 是否存在。

@godspeedai/cognate-client 支持 ESM 还是 CommonJS?

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

@godspeedai/cognate-client 可以商用吗?

@godspeedai/cognate-client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@godspeedai/cognate-client 的下载量有多少?

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

@godspeedai/cognate-client 还在维护吗?

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