defineEvidenceChecklist
KIT · function · 运行时值
Compile a reusable completion checklist over actual observations.
A requirement is satisfied when at least one observation satisfies the provider registered for its kind; isComplete requires every requirement to be satisfied, and missing returns those that are not. Hosts define evidence semantics.
导入
import { defineEvidenceChecklist } from '@jangts/agent-core/kits/evidence';import { defineEvidenceChecklist } from '@jangts/agent-core/kits/evidence';其他公开入口:@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/kits/evidence、@jangts/agent-core/kits。
定义
泛型参数
| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Observation | — | — |
Requirement | EvidenceRequirement | — |
调用
defineEvidenceChecklist<Observation, Requirement extends EvidenceRequirement>(definitions: readonly EvidenceProvider<Observation, Requirement>[]): Readonly<{ isSatisfied: (request: { observations: readonly Observation[]; requirement: Requirement; }) => boolean; isComplete: (request: { observations: readonly Observation[]; requirements: readonly Requirement[]; }) => boolean; missing({ observations, requirements, }: { observations: readonly Observation[]; requirements: readonly Requirement[]; }): Requirement[]; }>Compile a reusable completion checklist over actual observations.
A requirement is satisfied when at least one observation satisfies the provider registered for its kind; isComplete requires every requirement to be satisfied, and missing returns those that are not. Hosts define evidence semantics.
| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Observation | — | — |
Requirement | EvidenceRequirement | — |
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
definitions | readonly EvidenceProvider<Observation, Requirement>[] | 必需 | — |
返回: Readonly<{ isSatisfied: (request: { observations: readonly Observation[]; requirement: Requirement; }) => boolean; isComplete: (request: { observations: readonly Observation[]; requirements: readonly Requirement[]; }) => boolean; missing({ observations, requirements, }: { observations: readonly Observation[]; requirements: readonly Requirement[]; }): Requirement[]; }>。
返回值结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
isSatisfied | (request: { observations: readonly Observation[]; requirement: Requirement; }) => boolean | 必需 | 见类型定义及调用场景。 |
isComplete | (request: { observations: readonly Observation[]; requirements: readonly Requirement[]; }) => boolean | 必需 | 见类型定义及调用场景。 |
missing | ({ observations, requirements, }: { observations: readonly Observation[]; requirements: readonly Requirement[]; }) => Requirement[] | 必需 | 见类型定义及调用场景。 |
使用示例
- Evidence:用真实观察检查完成性:用 App 定义的证据语义检查需求,避免把模型的“完成了”当成真实回执。
检查真实资料是否已读取
入门 · Node.js
import { Evidence } from '@jangts/agent-core/kits/evidence';
type Observation = { sourceId: string; read: boolean };
type Requirement = { id: string; kind: 'source-read'; sourceId: string };
const checklist = Evidence.defineEvidenceChecklist<Observation, Requirement>([
{ kind: 'source-read', description: '资料读取已成功', isSatisfied: (seen, need) => seen.read && seen.sourceId === need.sourceId },
]);
console.log(checklist.isComplete({ observations: [{ sourceId: 'manual', read: true }], requirements: [{ id: 'need-manual', kind: 'source-read', sourceId: 'manual' }] }));import { Evidence } from '@jangts/agent-core/kits/evidence';
const checklist = Evidence.defineEvidenceChecklist([
{ kind: 'source-read', description: '资料读取已成功', isSatisfied: (seen, need) => seen.read && seen.sourceId === need.sourceId },
]);
console.log(checklist.isComplete({ observations: [{ sourceId: 'manual', read: true }], requirements: [{ id: 'need-manual', kind: 'source-read', sourceId: 'manual' }] }));相同清单返回缺口,再限定审查所用来源
配置 · Node.js
import { Evidence } from '@jangts/agent-core/kits/evidence';
type Observation = { sourceId: string; read: boolean };
type Requirement = { id: string; kind: 'source-read'; sourceId: string };
const checklist = Evidence.defineEvidenceChecklist<Observation, Requirement>([
{ kind: 'source-read', description: '资料读取已成功', isSatisfied: (seen, need) => seen.read && seen.sourceId === need.sourceId },
]);
console.log(checklist.missing({ observations: [], requirements: [{ id: 'need-manual', kind: 'source-read', sourceId: 'manual' }] }));
type ToolObservation = { toolId: string; sources: { id: string; text: string }[] };
const projection = Evidence.defineEvidenceProjection<ToolObservation, { id: string; text: string }>({
sourceId: source => source.id,
providers: { search: { sources: row => row.sources, withSources: (row, sources) => ({ ...row, sources }) } },
});
console.log(projection.project({ observations: [{ toolId: 'search', sources: [{ id: 'manual', text: '使用指南' }, { id: 'faq', text: '常见问题' }] }], sourceIds: ['manual'] }));import { Evidence } from '@jangts/agent-core/kits/evidence';
const checklist = Evidence.defineEvidenceChecklist([
{ kind: 'source-read', description: '资料读取已成功', isSatisfied: (seen, need) => seen.read && seen.sourceId === need.sourceId },
]);
console.log(checklist.missing({ observations: [], requirements: [{ id: 'need-manual', kind: 'source-read', sourceId: 'manual' }] }));
const projection = Evidence.defineEvidenceProjection({
sourceId: source => source.id,
providers: { search: { sources: row => row.sources, withSources: (row, sources) => ({ ...row, sources }) } },
});
console.log(projection.project({ observations: [{ toolId: 'search', sources: [{ id: 'manual', text: '使用指南' }, { id: 'faq', text: '常见问题' }] }], sourceIds: ['manual'] }));