@cognitum-one/sdk

中文文档
0.4.0发布于 2026/09/21Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 1.7万

Official Cognitum SDK for Node.js and TypeScript

原始使用文档
文档目录6 节
  1. Install
  2. Quick start — talking to a Seed
  3. Features
  4. Agentic layer (v0.3)
  5. Documentation
  6. License

@cognitum-one/sdk

Official Cognitum SDK for Node.js and TypeScript.

Talk to a Cognitum Seed appliance (direct, over mDNS / USB gadget / LAN) or the Cognitum Cloud control plane (api.cognitum.one).

Install

npm install @cognitum-one/sdk
# optional: mDNS discovery
npm install multicast-dns

Requires Node.js >=18.

Quick start — talking to a Seed

import { SeedClient } from "@cognitum-one/sdk/seed";

const client = new SeedClient({
  endpoints: "https://cognitum.local:8443",
  tls: { insecure: true }, // dev-only; use tls.ca for production
});

const status = await client.status();
console.log(`seed ${status.deviceId}, epoch ${status.epoch}`);

const result = await client.store.query({ vector: [0.1, 0.2, /*...*/ 0.8], k: 3 });

Features

  • 12 typed seed endpoints (status, pair, witness, custody, store, OTA, …)
  • Mesh routing with closest-first, session-sticky reads, failover on 5xx
  • client.mesh() observability wrappers (status / peers / swarm / cluster)
  • Per-call CallOptions — peer / prefer / consistency / timeout / retries
  • Discovery providers: ExplicitDiscovery, MdnsDiscovery, TailscaleDiscovery
  • TLS — explicit CA, fp=sha256:<hex> cert pinning, or dev-only insecure
  • Trust-score 3-strike cutoff; redacting SecretString around pairing tokens
  • ADR-0005 retry / rate-limit (500 ms base, 30 s cap, 60 s wall-clock)
  • MCP client with both HTTP and stdio transports

Agentic layer (v0.3)

Bounded clients for Meta-LLM, Meta-Proxy, HarnessaaS, and MetaHarness, plus a shared agentic contract layer, all additive to the Seed/Cloud client above.

import { MetaLlmClient } from "@cognitum-one/sdk/meta-llm";
import { StaticApiKeyCredentialProvider } from "@cognitum-one/sdk/agentic";

const llm = new MetaLlmClient({
  baseUrl: "https://api.cognitum.one",
  credentialProvider: new StaticApiKeyCredentialProvider({
    product: "meta-llm",
    normalizedOrigin: "https://api.cognitum.one",
    audience: "https://api.cognitum.one", // must match baseUrl (ADR-0022 §D3)
  }), // reads COGNITUM_API_KEY by default
});

// Each yielded value is a MetaLlmStreamEnvelope<OpenAiStreamEvent> -- the
// event itself lives on .event; the envelope only carries metadata
// (sequence, receivedAt, requestId, ...).
for await (const envelope of llm.chat.completionsStream({
  model: "cognitum-meta-llm",
  messages: [{ role: "user", content: "hello" }],
})) {
  if (envelope.event.type === "content_delta") process.stdout.write(envelope.event.delta);
}
NamespaceMaturityNotes
@cognitum-one/sdk/agenticAvailableCredentials, typed errors/retry, receipts + lineage, redaction, W3C trace context. Telemetry primitives are public/tested but no product client wires them into a live emission path yet.
@cognitum-one/sdk/meta-llmAvailable6 serving protocols, OpenAI/Anthropic SSE streaming, routing, receipts. Platform resources (batches, pods, Brain, …) are REST-only — issue #59.
@cognitum-one/sdk/meta-proxyAvailableLocal status/capabilities + chat.completions forwarding (streaming + non-streaming), consent-gated cloud routing.
@cognitum-one/sdk/harnessaasAvailableReal synchronous health / solve / lineage. No async job/poll/approval contract exists upstream yet.
@cognitum-one/sdk/metaharnessContract previewFull typed surface, every call fail-closed — no published local bridge protocol yet.

See ../../capabilities/sdk-release.v1.json for the full, machine-readable maturity/feature matrix across all 3 SDKs.

Documentation

License

Apache-2.0 — see LICENSE.

版本与发布记录

@cognitum-one/sdk 共发布 3 个版本,首次发布于 2026/04/30;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.0latest2026/09/211 个月前
0.3.02026/07/203 个月前
0.2.12026/04/306 个月前

关于 @cognitum-one/sdk 的常见问题

@cognitum-one/sdk 是什么?

Official Cognitum SDK for Node.js and TypeScript

如何安装 @cognitum-one/sdk?

在项目目录运行 npm install @cognitum-one/sdk,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cognitum、cognitum-sdk,可以用 npx cognitum 直接运行。

@cognitum-one/sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cognitum-one/sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@cognitum-one/sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@cognitum-one/sdk 可以商用吗?

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

@cognitum-one/sdk 的下载量有多少?

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

@cognitum-one/sdk 还在维护吗?

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