@godspeedai/cognate-cognitive-api

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

无依赖的认知Index合同、检索管道、索引投影和符合性包(第14-16段).

中文使用文档
文档目录7 节
  1. 安装
  2. 快速开始: 召回
  3. 不断提供指数:指数预测
  4. 指数执行合规工具包
  5. 限制
  6. 相关软件包
  7. 许可证

@ 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 返回为.
  • 重复拒绝的或缺失的源头 无意中给哪些源带来信号.

许可证

阿帕奇 - 2.0

版本与发布记录

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

@godspeedai/cognate-cognitive-api 是什么?

无依赖的认知Index合同、检索管道、索引投影和符合性包(第14-16段).

如何安装 @godspeedai/cognate-cognitive-api?

在项目目录运行 npm install @godspeedai/cognate-cognitive-api,或使用 pnpm add / yarn add / bun add。

@godspeedai/cognate-cognitive-api 支持 TypeScript 吗?

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

@godspeedai/cognate-cognitive-api 支持 ESM 还是 CommonJS?

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

@godspeedai/cognate-cognitive-api 可以商用吗?

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

@godspeedai/cognate-cognitive-api 的下载量有多少?

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

@godspeedai/cognate-cognitive-api 还在维护吗?

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