@ godspideai/ cognate- 认知- api
Cognate应用程序检索合同:a CognitiveIndex 界面,标准
回顾管道、由事件驱动的索引预测和索引配套工具
执行。 它没有定义矢量数据库,也没有嵌入模型——执行和
嵌入器插进.
何时使用此软件包 : 你正在建造或消耗语义记忆
),并需要一个在索引后端上工作的界面
管道内装有租户/扫描器过滤和授权,而不是栓上.
选择诸如
@godspeedai/cognate-cognitive-memory, (中文(简体) ),
@godspeedai/cognate-cognitive-ruvector, (中文(简体) ),
或者说 @godspeedai/cognate-cognitive-rvf。 。 。 .
安装
bun add @godspeedai/cognate-cognitive-api
要求数 阿宝 >= 1.4.0. SDK 船 Bun-native TypeScript源, 因此添加
@types/bun 财务报告和审定财务报表 @types/node 在检查您的工程时, 作为非依赖性 .
快速开始: 召回
import { createRecall } from "@godspeedai/cognate-cognitive-api";
import { createMemoryIndex, hashingEmbedder } from "@godspeedai/cognate-cognitive-memory";
const recall = createRecall({
index: createMemoryIndex({ dimension: 256 }),
embedder: hashingEmbedder(256),
resolver: {
// Fetch authoritative content for an entry's source, with your own authorization.
async resolve(sourceRef, actor, tenant) {
return { kind: "ok", value: { text: "Refunds are approved by a manager." } };
},
},
});
const result = await recall.recall({
text: "who approves refunds?",
actor: { id: "alice", kind: "user" },
tenant: "tenant-a",
scopeIds: [],
k: 5,
});
if (result.status === "ok") {
for (const item of result.items) console.log(item.sourceRef, item.score);
} else {
// "degraded": the index or embedder was unavailable; continue without cognition
console.warn(result.reason);
}
管道:嵌入查询,询问候选人的指数(带有租户/范围预过滤),
重新检查每个候选人的出处 与查询的租户和范围,然后取
通过您 SourceResolver. 被拒绝或失踪的来源
静静地放弃——回顾从未透露存在结果。 结果从未超过 k。 。 。 .
如果指数或嵌入器投出,则回想会降低到 { status: "degraded", items: [] } 除非
查询集 required: true,在这种情况下,它投掷 CognitionUnavailableError。 。 。 .
不断提供指数:指数预测
cognitiveIndexer 是将持久事件转化为索引条目的预测。 你提供
一个决定性因素 extract 每个事件; 投影嵌入所提取的文档
并提升它们(通过条目id来识别,所以回放是安全的). 当事件的有效载荷是
被去除,其衍生条目被去除——甚至跨越重启.
import { cognitiveIndexer } from "@godspeedai/cognate-cognitive-api";
const indexer = cognitiveIndexer({
name: "my-cognition",
version: "1",
index, // a CognitiveIndex
embedder, // an Embedder
extract: (event) =>
event.eventType === "doc.created"
? [{ id: `doc:${event.eventId}`, sourceType: "event", sourceRef: `event:${event.eventId}`,
tenant: event.tenant, scopeId: event.scopeId, semanticRef: null, eventRef: event.eventId,
traceRef: null, metadata: {}, relationships: [], validFrom: event.occurredAt, validTo: null,
text: String((event.payload as { title?: string }).title ?? "") }]
: [],
});
用投影跑者运行它(参考跑时通过它的 projections
选项),或自行驱动
@godspeedai/cognate-projections。 。 。 .
指数执行合规工具包
这个 @godspeedai/cognate-cognitive-api/conformance 子路径导出
cognitiveIndexConformance(name, make) - 行为套房(最近的第一订单,
一元化的上升,出处保护,房客隔离,范围限制,维度
检查)和 entry() 帮手 科格纳特家族的每一项指数执行情况
不加修改地通过它;在信任它之前,先与你自己的执行相对立.
限制
- 这个包船没有指数也没有嵌入器——质量完全取决于你的选择.
- 索引候选人从来不具有权威性
SourceResolver返回为. - 重复拒绝的或缺失的源头 无意中给哪些源带来信号.
相关软件包
@godspeedai/cognate-cognitive-memory—— 说 正在处理中 精确的cosine 指数和确定性散列器.@godspeedai/cognate-cognitive-ruvector—— 说 由外部 RuVector 库支持索引.@godspeedai/cognate-cognitive-rvf—— 说 有快照/分支支持的RVF文件支持的索引.@godspeedai/cognate-events财务报告和审定财务报表@godspeedai/cognate-projections—— 说 事件存储和投影机 索引器所依赖的.@godspeedai/cognateSDK伞.
许可证
阿帕奇 - 2.0