@devflow-tools/knowledge-engine
v0.18.3
Published
Version-aware project knowledge ingestion and retrieval for DevFlow.
Readme
@devflow-tools/knowledge-engine
同步官方文档并进行结构化切分、BM25/混合检索和知识质量评估。(v0.17.8)
安装
npm install @devflow-tools/knowledge-engine快速开始
import { KnowledgeEngine } from '@devflow-tools/knowledge-engine';
const engine = new KnowledgeEngine({ projectRoot: process.cwd() });
await engine.registerSource({ name: 'react', urls: ['https://react.dev/reference'], pluginName: 'react', version: '19' });
await engine.syncDocs('react');
console.log(await engine.search('useEffect cleanup'));公共 API / 命令
KnowledgeEngine、KnowledgeStore、KnowledgeHybridSearch、fetchHtmlSmart、bm25Search、compileKnowledgeSource、evaluateKnowledgeQuality。
配置与运行时
默认构造函数是 lexical-only,避免与 memory-engine 形成依赖环;注入 SDK 的 EmbeddingProviderContract 实现后才启用向量检索/回填。SPA 抓取需要 npx playwright install chromium。
版本与兼容性
- 当前包版本:
0.17.8 - Node.js:未在 package manifest 声明更高版本时,使用 Node.js 18+;原生 SQLite/Playwright 能力请按对应依赖安装
- workspace 内部包应使用同一 DevFlow minor/patch 版本,避免类型和数据库 schema 不一致
相关链接
License
MIT
