KnowledgeDocument

KIT · interface · 类型合同

One versioned document as supplied by the App.

导入

TypeScript

import type { KnowledgeDocument } from '@jangts/agent-core/kits/knowledge';

JavaScript

/** @typedef {import('@jangts/agent-core/kits/knowledge').KnowledgeDocument} KnowledgeDocument */

其他公开入口：@jangts/agent-core/types、@jangts/agent-core/kits/knowledge、@jangts/agent-core/kits。

定义

interface KnowledgeDocument

字段结构

字段	类型	必需	说明
id	string	必需	只读。Stable document id; duplicate ids are rejected by the catalog.
revision	string	必需	只读。Revision label recorded in every snapshot so a citation names the exact content.
locale	string | undefined	可省略	只读。Locale of the content, when the App maintains translations.
parts	readonly KnowledgePart[]	必需	只读。Ordered content.

使用示例

• Knowledge：资料、章节与证据快照：同一份资料合同支持普通对象与带锚点的文本；选读后得到明确版本的证据快照。
• 知识候选：编译检查与显式发布：候选准备与发布复用 Knowledge 编译器，真实存储通过 CAS 提交正式资料。

先读取一份普通对象资料

入门 · Node.js

TypeScript

import { Knowledge } from '@jangts/agent-core/kits/knowledge';
const catalog = Knowledge.defineKnowledgeCatalog([
  { id: 'manual', revision: '1', parts: ['Agent Core 支持普通 Workflow 节点。'] },
]);
const snapshot = catalog.read({ documentId: 'manual', selection: { mode: 'document' } });
console.log(snapshot.content, snapshot.revision);

JavaScript

import { Knowledge } from '@jangts/agent-core/kits/knowledge';
const catalog = Knowledge.defineKnowledgeCatalog([
    { id: 'manual', revision: '1', parts: ['Agent Core 支持普通 Workflow 节点。'] },
]);
const snapshot = catalog.read({ documentId: 'manual', selection: { mode: 'document' } });
console.log(snapshot.content, snapshot.revision);

在相同 read 上增加章节与预算

配置 · Node.js

TypeScript

import { Knowledge } from '@jangts/agent-core/kits/knowledge';
const catalog = Knowledge.defineKnowledgeCatalog([
  { id: 'manual', revision: '2', parts: [
    { id: 'start', parts: ['先运行一个节点。', { id: 'advanced', parts: ['再增加模型和工具。'] }] },
  ] },
], { maxChars: 2000 });
console.log(catalog.sectionIds('manual'));
const snapshot = catalog.read({ documentId: 'manual', selection: { mode: 'subtree', sectionIds: ['start'] } });
console.log(snapshot.content, snapshot.id);

JavaScript

import { Knowledge } from '@jangts/agent-core/kits/knowledge';
const catalog = Knowledge.defineKnowledgeCatalog([
    { id: 'manual', revision: '2', parts: [
            { id: 'start', parts: ['先运行一个节点。', { id: 'advanced', parts: ['再增加模型和工具。'] }] },
        ] },
], { maxChars: 2000 });
console.log(catalog.sectionIds('manual'));
const snapshot = catalog.read({ documentId: 'manual', selection: { mode: 'subtree', sectionIds: ['start'] } });
console.log(snapshot.content, snapshot.id);

相关策略源码

• 选读、预算和快照标识
• 文本章节解析与树编译
• 资料候选编译、来源检查与 CAS 发布

相关定义

• KnowledgePart
• KnowledgeSection