@ godspideai/ cognate- react
对Cognate进行19个装订:将运行,活预测,前端能力,续作,以及文物放入您组件的无头客户端上薄钩. 设计-系统免费——带出自己的渲染器.
何时使用此软件包 : 您为 Cognate 运行时间构建一个 React 前端, 并想要处理状态管道( 订阅、 重放、 注册生命周期) 而不采用组件库 。 现成聊天/核准/艺术表面,层 @godspeedai/cognate-ui-astryx 在顶上.
安装
bun add @godspeedai/cognate-react
要求数 阿宝 ++ 1.4.0和++++ 反应 19.3.0 (被宣布为同伴依赖, "react": "19.3.0") (中文(简体) ). 取决于 @godspeedai/cognate-client 每个钩子都读取 CognateClient,这仍然是真相的唯一来源。 包件船 Bun-native TypeScript 源; 如果您在 Bun 外键入, 请添加 @types/bun 财务报告和审定财务报表 @types/node。 。 。 .
快开始
import { createClient } from "@godspeedai/cognate-client";
import { CognateProvider, useAgent, useContinuations } from "@godspeedai/cognate-react";
import { createRuntime } from "@godspeedai/cognate-runtime-bun";
const runtime = await createRuntime({
store: ":memory:",
agents: [myAgent],
policy, // your kernel invocation policy
actions, // your action authorization
});
const caller = { actor: { id: "alice", kind: "user" }, tenant: "tenant-a" };
const client = createClient({ service: runtime.service, caller });
function App() {
const { start, runId, state } = useAgent("agent.support");
const { open, resolve } = useContinuations(runId);
return (
<main>
<button onClick={() => void start({ message: "I was double charged" })}>Ask</button>
<p>{state?.text}</p>
{open
.filter((c) => (c.condition as { kind?: string } | null)?.kind === "human_approval")
.map((c) => (
<button key={c.id} onClick={() => void resolve(c.id, "resume", { approved: true })}>
Approve {c.id}
</button>
))}
</main>
);
}
// Wrap once, near the root:
<CognateProvider client={client}><App /></CognateProvider>;
钩子
| 钩子 | 目的 |
|---|---|
useCognate() | 从最近的客户端 CognateProvider |
useRun(runId) | 现场直播 RunState 状态,流式 text,错误,打开的续作,文物,衍生状态 |
useAgent(agent) | start(input),最新数据 runId及其状态 |
useSharedState(runId) | 运行的活共享状态加 update(patchOrSnapshot); 写解决一旦持久并被被中止代理通过 RunContext.state |
useThreadSharedState(threadId) | 相同的, 由所有运行在线程中共享 |
useProjection(name) | 公开投影的条目 |
useCapability(capability, handler) | 在组件挂起时服务前端能力; 未注册在卸载上, 留下任何打开的继续等待 |
useRemoteCapability(offer, handler, options?) | (一) 发布装机寿命的描述式辅助远程能力; options.render 记录每个持久呼叫的用户界面;返回 { status, error } |
useRemoteCapabilityHistory(runId) | 运行中远程能力呼叫(仅同一次) |
useContinuations(runId) | 打开续作+ resolve(id, "resume" | "cancel", input?) |
useArtifact(artifactId) | 获取文物 : { status, name, mediaType, text? } (文本解码为: text/* 媒体类型) |
useConnectionStatus() | 客户端的连接状态 |
所有订阅钩是 useSyncExternalStore 适配器凌驾于客户端的被动存储器之上,因此它们也在服务器渲染下工作:客户端将缓冲历史重放入第一次订阅.
限制
- 软件包没有做任何事情,也没有风格;它是钩子和提供者。 Astryx 类型和组件按设计不开放.
- 远程能力使出处活在挂载提供者的内存中——在整页重新装入之后,耐用电话仍然可以检查,但原始的渲染器组件已经消失.
useCapability财务报告和审定财务报表useRemoteCapability后续组件寿命:卸载会撤回能力或提议; 代理等待中位停留,而不是倒下.
相关软件包
@godspeedai/cognate-client无头客户 这些钩子绑住.@godspeedai/cognate-ui-astryx——参考基于此套件的Astryx组件.@godspeedai/cognate-runtime-bun跑步时间.@godspeedai/cognate-profile-copilot——使用这些绑定的由编组组成的交互聊天应用程序.@godspeedai/cognateSDK伞.
许可证
阿帕奇 - 2.0