@ godspideai/ cognate- 艺术
为Cognate应用程序提供持久、内容地址、访问控制的文件存储。 艺术品 用于生成或消费二进制内容——报告、文件、, 图像,数据文件——这些文件必须活过重启,并保持可审计性.
何时使用此软件包 : 您的代理人或能力需要将文件附加到运行中
稍后读取, 并带有用户访问控制、保留元数据以及删除
留下明确的墓碑 而不是悄悄地消失 它将一切储存在任何
@godspeedai/cognate-events
DurableStore所以坚韧不拔跟你的店一样耐用.
安装
bun add @godspeedai/cognate-artifacts
要求数 阿宝 您还需要一个商店:
@godspeedai/cognate-store-sqlite
长期储存或
@godspeedai/cognate-store-memory
测试。 SDK号飞船 Bun-native TypeScript源, 所以添加 @types/bun 财务报告和审定财务报表 @types/node
在检查您的工程时, 作为非依赖性 .
快开始
import { openSqliteStore } from "@godspeedai/cognate-store-sqlite";
import { ArtifactService } from "@godspeedai/cognate-artifacts";
const store = openSqliteStore({ path: "./app.sqlite" });
const artifacts = new ArtifactService(store);
const alice = { id: "alice", kind: "user" } as const;
const record = await artifacts.put({
name: "refund-report.md",
mediaType: "text/markdown",
bytes: new TextEncoder().encode("# Refund\napproved"),
access: { tenant: "tenant-a", scopeId: "root", readers: ["alice"] },
runId: "run-1",
correlationId: "corr-1",
retention: { class: "case-7y", until: "2033-01-01T00:00:00Z" },
});
const read = await artifacts.get(record.id, alice, "tenant-a");
if (read.kind === "ok") {
console.log(record.contentHash); // `sha256:<hex>` of the bytes
console.log(new TextDecoder().decode(read.bytes));
}
// Only principals in `readers` of the right tenant may read:
await artifacts.get(record.id, { id: "bob", kind: "user" }, "tenant-a"); // { kind: "denied" }
如何表现
- 写出头字节.
put存储已处理的字节内容( c)sha256:<hex>(中文(简体) ) 在此之前 记录及其记录artifact.created事件,所以没有 内容。 相同的字节被存储一次,甚至跨出文物. - 诚实的阅读.
get返回歧视性结果 :ok, (中文(简体) ),denied(租户与否) 在读者许可名单上,not_found, (中文(简体) ),tombstoned(在你的下方被彻底清除) 保留/空缺政策),或lost(记录已存在,但其字节已消失——已报告) 明显是数据损失,从未隐藏在未找到的答案后). - 删取为墓志铭.
delete(id, reason, actor)标记记录tombstoned与 他们删除了它,为什么, 然后删除字节blobs 没有剩余的文物参考文献 - 共享内容仍然可以删除任何一种引用者. - 示众. 一种工艺品可以携带多种介质类型(例如:
原件外加JSON表格视图;
get(id, actor, tenant, "application/json")选择一个. - 列表(上册).
list({ tenant, runId? }, actor)返回只记录已授权的演员 读取.
限制
- 保留(
class财务报告和审定财务报表until)是被记录的元数据。 本套件列表中无任何内容或 执行期满——以你自己的工作为基础. - 访问控制是每件文物和租户匹配的平面读取码许可列表. 作用, 团队 和全方位的政策 是您的应用工作.
list扫描所有文物记录;没有二级索引.- 墓碑记录把他们的事件记录保存在商店里. 擦除事件有效载荷是 存储的有效载荷感应特性, 不是这个包做的.
相关软件包
@godspeedai/cognate-events—— 说 页:1DurableStore合同和事件信封,这项服务是建立在上.@godspeedai/cognate-store-sqlite—— 说 耐用SQLite商店;@godspeedai/cognate-store-memory—— 说 做测试的记忆店.@godspeedai/cognate-runtime-bun—— 说 参考运行时间; 它为您运行此服务, 并通过它的 API 曝光文物 .@godspeedai/cognate- SDK车 雨伞;最容易获得有文物支持的运行时间.
许可证
阿帕奇 - 2.0