@godspideai/cognate-ui-astryx (英语)
用于 Cognate 的参考聊天应用表面,使用 Astryx 图像 设计系统:一个应用外壳、聊天面板、批准卡、文物取景器和运行/状态检查员,其中包含轻型/暗色主题.
何时使用此软件包 : 您想要一个工作,可访问的Cognate UI从盒子中取出,或者在组合自己时提供具体的参考. 它是一个渲染器,而不是本体学——这里的所有东西都作曲 @godspeedai/cognate-react 钩子和可格纳特型号仅此而已,因此互换设计系统意味着替换这个包而别无他法. 对于没有组件的装订,使用 @godspeedai/cognate-react 直接说.
安装
bun add @godspeedai/cognate-ui-astryx
要求数 阿宝 ++ 1.4.0和++++ 反应 19.3.0 与 反应-比分 19.3.0 (均被宣布为同级依赖). Astryx 本身 (@astryxdesign/core, (中文(简体) ), @astryxdesign/theme-neutral)是一种经常性的依赖。 包件船 Bun-native TypeScript 源; 如果您在 Bun 外键入, 请添加 @types/bun 财务报告和审定财务报表 @types/node。 。 。 .
快开始
import { useState } from "react";
import { createClient } from "@godspeedai/cognate-client";
import { CognateProvider } from "@godspeedai/cognate-react";
import { Approvals, ChatPanel, CognateShell, RunInspector } from "@godspeedai/cognate-ui-astryx";
const client = createClient({ service: runtime.service, caller }); // runtime from @godspeedai/cognate-runtime-bun
function App() {
const [runId, setRunId] = useState<string>();
return (
<CognateProvider client={client}>
<CognateShell title="Support copilot">
<ChatPanel agent="agent.support" placeholder="Ask about a refund" onRunStarted={setRunId} />
<Approvals runId={runId} />
<RunInspector runId={runId} />
</CognateShell>
</CognateProvider>
);
}
输入信件后, 面板会启动代理运行; 流出时会显示助手文本; 批准式的续作为通过客户端解决的核准/拒绝卡; 检查员跟踪状态、 打开续作和文物。 外壳在服务器侧渲染下工作( S)renderToString 生成光和暗模式下的可获取标记)和水合物与活运行时间相对.
表面
| 构成部分 | 目的 |
|---|---|
CognateShell({ title, mode?, onModeChange?, children }) | Astryx 有标题( 标题、 浅/ 暗切) 和主区域的主题包装; 邮票 data-cognate-theme 在其根上 |
ChatPanel({ agent, placeholder?, onRunStarted? }) | 启动于 useAgent; 显示流式回复 |
ApprovalCard({ continuation, onResolve }) | 一种续用类型和有效载荷 |
Approvals({ runId }) | 所有公开的核准式继续作为卡片运行,通过 useContinuations |
ArtifactViewer({ artifactId }) | text/* 作为文本, JSON 作为可访问的密钥/ 值表对象, 其他任何东西作为下载链接 |
RunInspector({ runId }) | 状态、错误、开放持续和文物清点 |
StateInspector({ runId }) | 该运行的衍生共享状态为格式化的 JSON |
服务样式表
Astryx ships 预编 CSS (没有风格构建步骤). stylesheetPaths() 从 ./styles 子路径解决主机页面必须链接或服务的两个样式表的绝对路径 :
import { stylesheetPaths } from "@godspeedai/cognate-ui-astryx/styles";
for (const path of stylesheetPaths()) registerStylesheet(path); // host-app specific
没有这些样式表 组件渲染和功能, 但不是与 Astryx 的预定外观.
限制
- 这些是参考面,而不是一个组件框架:除了Astryx自己的外,没有公共主题API
Theme编号 :mode由CognateShell。 。 。 . - 聊天面板包含一个代理和最新运行的文本;多运行的对话视图由您编写
@godspeedai/cognate-react钩子. - 仅提供文本,JSON-object,和下载-链接的文物渲染.
相关软件包
@godspeedai/cognate-react——这里的每个地表都由钩子来建造.@godspeedai/cognate-client下方的无头客户端.@godspeedai/cognate-profile-copilot- 一种完整的应用简介,说明这些船只的表面.@godspeedai/cognateSDK伞.
许可证
阿帕奇 - 2.0