@godspeedai/cognate-profile-copilot

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

副驾驶参考简介:运行时间、运行、续作、前端能力、状态和文物预测、AG-UI、React和Astryx的构成(第29.1段)。 无内核添加.

中文使用文档
文档目录6 节
  1. 安装
  2. 快开始
  3. 剖面图的内容
  4. 限制
  5. 相关软件包
  6. 许可证

@godspideai/cognate-profile-copilot(英语:

副驾驶参考简介:由已存在的Cognate套件所构成的完整交互式聊天应用程序——模型与工具代理循环,人类认可,浏览器服务的前端工具,共享状态和文物预测,AG-UI端点,以及React/Astryx表面. 它不添加新的内核或运行时间原始;每块都是一个也可以单独使用的包.

何时使用此软件包 : 您想要工作聊天- copilot 骨架( 流回、 批准后端工具、 浏览器服务工具、 基因UI ) 在编组您自己的工具之前, 运行为当前或研究 。 对于一个自主的会话和排程样式代理,请参见 @godspeedai/cognate-profile-harness。 。 。 .

安装

bun add @godspeedai/cognate-profile-copilot

要求数 阿宝 ++ 1.4.0和++++ 反应 19.3.0 与 反应-比分 19.3.0 (均被宣布为同级依赖). 其基础是 @godspeedai/cognate-runtime-bun, (中文(简体) ), @godspeedai/cognate-ag-ui, (中文(简体) ), @godspeedai/cognate-react,以及 @godspeedai/cognate-ui-astryx; 模型连接到 @godspeedai/cognate-provider-openai-compatible。 。 。 .

快开始

import { createClient } from "@godspeedai/cognate-client";
import { openAICompatible } from "@godspeedai/cognate-provider-openai-compatible";
import { COPILOT_AGENT, createCopilotApp, GenerativeSurface } from "@godspeedai/cognate-profile-copilot";
const app = await createCopilotApp({
  store: "./copilot.sqlite",
  model: openAICompatible({
    id: "main",
    baseURL: process.env.MODEL_BASE_URL!,
    model: "my-model",
    apiKey: () => process.env.MODEL_API_KEY!, // read per request, never stored
  }),
  instructions: "You are a support copilot.",
  backendTools: [
    {
      contract: { id: "refund.approve", version: "1.0.0" },
      description: "Issue a refund",
      inputSchema: { type: "object" },
      handler: (input) => ({ refunded: (input as { amount: number }).amount }),
      requiresApproval: true, // pauses the run as a human-approval continuation
      statePatch: (input) => [{ op: "add", path: "/refund", value: { amount: (input as { amount: number }).amount, status: "refunded" } }],
      render: (input) => ({ component: "RefundCard", props: { amount: (input as { amount: number }).amount } }),
      artifact: (input, output) => ({ name: "refund-receipt.json", mediaType: "application/json", content: JSON.stringify({ request: input, result: output }) }),
    },
  ],
  frontendTools: [{ name: "map.focus", description: "Focus the map", inputSchema: { type: "object" } }],
});

// Serve the AG-UI endpoint (SSE) for browser clients:
Bun.serve({ port: 3000, fetch: app.agUi });

连接客户端服务 map.focus 并且决定批准:

import { useCapability } from "@godspeedai/cognate-react";

const caller = { actor: { id: "alice", kind: "user" }, tenant: "tenant-a" };
const client = createClient({ service: app.runtime.service, caller });
client.provideCapability("map.focus", (input) => ({ centered: true }));

// Or per component lifetime:
function MapTool() {
  useCapability("map.focus", (input) => ({ centered: true }));
  return null;
}

// Render a run's generative-UI events with your own component registry:
function Surface({ runId }: { runId: string }) {
  return <GenerativeSurface runId={runId} components={{ RefundCard: (props) => <b>Refund of {String(props.amount)}</b> }} />;
}

一个未知的组件名称使得一个占位符而不是抛出,而表面在服务器侧渲染下工作,因为客户端将它的缓冲事件重放到第一个订阅中.

剖面图的内容

关切备份软件包
运行时间, 持久运行@godspeedai/cognate-runtime-bun
续作(核准)@godspeedai/cognate-continuations
前端能力@godspeedai/cognate-runtime-api
状态/艺术预测@godspeedai/cognate-client
AG- UI 端点@godspeedai/cognate-ag-ui
反应绑定@godspeedai/cognate-react
界面表面@godspeedai/cognate-ui-astryx

导出 copilotProfile 财务报告和审定财务报表 copilotRegistry 按名称宣布这一组成(resolveProfile 从 @godspeedai/cognate-profile 解决现有软件包的每个条目) COPILOT_AGENT 是内置代理 id (agent.copilot) (中文(简体) ).

在运行中,副驾驶代理流模型输出为 message.delta,通过能力合同引用核准的后端工具,为客户服务前端工具作为续作,并发布 state.changed, (中文(简体) ), ui.render,以及客户可以折叠成共享状态,基因UI,以及文物列表的文物事件. 运行在完全应用程序重新启动后幸存:等待续作在他们离开的地方恢复.

限制

  • 内置的 AG- UI 端点认证与开发 Bearer <tenant>:<user> 象征性的大会——带来自己的 authenticate (编) createAgUiHandler 从 @godspeedai/cognate-ag-ui 直接的) 对于任何真实的.
  • 每个应用实例一个副驾驶代理;多代理线路由您添加.
  • requiresApproval 仅凭人类决定的大门——没有制定自动批准或授权政策.

许可证

阿帕奇 - 2.0

版本与发布记录

@godspeedai/cognate-profile-copilot 共发布 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-profile-copilot 的常见问题

@godspeedai/cognate-profile-copilot 是什么?

副驾驶参考简介:运行时间、运行、续作、前端能力、状态和文物预测、AG-UI、React和Astryx的构成(第29.1段)。 无内核添加.

如何安装 @godspeedai/cognate-profile-copilot?

在项目目录运行 npm install @godspeedai/cognate-profile-copilot,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(19.3.0)、react-dom(19.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@godspeedai/cognate-profile-copilot 支持 TypeScript 吗?

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

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

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

@godspeedai/cognate-profile-copilot 可以商用吗?

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

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

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

@godspeedai/cognate-profile-copilot 还在维护吗?

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