インストール

@knowledgepulse/sdk パッケージは、KnowledgePulse プロトコルのための TypeScript/JavaScript 型、バリデーションスキーマ、ナレッジキャプチャ、取得、スコアリング、SKILL.md ユーティリティを提供します。

バージョン: 0.1.0
ライセンス: Apache-2.0

インストール

Bun
npm
Yarn
pnpm

bun add @knowledgepulse/sdk

npm install @knowledgepulse/sdk

yarn add @knowledgepulse/sdk

pnpm add @knowledgepulse/sdk

モジュールフォーマット

SDK は完全な TypeScript 宣言付きのデュアルフォーマットパッケージとして出荷されます。ESM と CommonJS の両方がそのまま使用できます。

ESM（推奨）

import {
  KPCapture,
  KPRetrieval,
  evaluateValue,
  parseSkillMd,
  KnowledgeUnitSchema,
} from "@knowledgepulse/sdk";

CommonJS

const {
  KPCapture,
  KPRetrieval,
  evaluateValue,
  parseSkillMd,
  KnowledgeUnitSchema,
} = require("@knowledgepulse/sdk");

エクスポートマップ

パッケージは条件付きエクスポートを持つ単一のエントリポイント（.）を公開します：

{
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "require": "./dist/index.cjs"
    }
  }
}

パス	フォーマット	ファイル
`types`	TypeScript 宣言	`dist/index.d.ts`
`import`	ESM	`dist/index.js`
`require`	CommonJS	`dist/index.cjs`

依存関係

パッケージ	バージョン	用途
`zod`	^3.23.0	すべてのナレッジユニットタイプのランタイムバリデーションスキーマ
`yaml`	^2.4.0	SKILL.md YAML フロントマターのパースと生成

オプション依存関係

パッケージ	バージョン	サイズ	用途
`@huggingface/transformers`	^3.0.0	~80 MB	新規性スコアリング用のエンベディングモデル（`Xenova/all-MiniLM-L6-v2`）

@huggingface/transformers パッケージはオプション依存関係として記載されています。evaluateValue() スコアリング関数の新規性次元でのみ使用されます。インストールされていない場合、新規性スコアはデフォルト値 0.5 にフォールバックします。

明示的にインストールするには：

bun add @huggingface/transformers

TypeScript

完全な型宣言がパッケージの dist/index.d.ts に含まれています。追加の @types/* パッケージは不要です。

SDK は TypeScript 5.0 以降を必要とし、ES2020 をターゲットにしています。tsconfig.json で moduleResolution: "bundler" または "node16" を使用している場合、エクスポートマップは自動的に解決されます。

// tsconfig.json（推奨設定）
{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "bundler",
    "target": "ES2020",
    "strict": true
  }
}