Evidence
KIT · constant · Runtime value
Import
ts
import { Evidence } from '@jangts/agent-core/kits/evidence';js
import { Evidence } from '@jangts/agent-core/kits/evidence';Other public entry points:@jangts/agent-core/types, @jangts/agent-core/kits/evidence, @jangts/agent-core/kits.
Definition
Member index
| Member | Purpose |
|---|---|
defineEvidenceChecklist | See the overload below for full inputs and outputs. |
defineEvidenceProjection | See the overload below for full inputs and outputs. |
Member details
defineEvidenceChecklist
ts
Evidence.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.
| Type parameter | Constraint | Default type |
|---|---|---|
Observation | — | — |
Requirement | EvidenceRequirement | — |
| Parameter | Type | Passing | Description |
|---|---|---|---|
definitions | readonly EvidenceProvider<Observation, Requirement>[] | Required | — |
Returns: 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[]; }>.
Return value structure
| Field | Type | Required | Description |
|---|---|---|---|
isSatisfied | (request: { observations: readonly Observation[]; requirement: Requirement; }) => boolean | Required | See the type definition and usage context. |
isComplete | (request: { observations: readonly Observation[]; requirements: readonly Requirement[]; }) => boolean | Required | See the type definition and usage context. |
missing | ({ observations, requirements, }: { observations: readonly Observation[]; requirements: readonly Requirement[]; }) => Requirement[] | Required | See the type definition and usage context. |
defineEvidenceProjection
ts
Evidence.defineEvidenceProjection<Observation, Source>(definition: EvidenceProjectionDefinition<Observation, Source>): Readonly<{ project({ observations, sourceIds, }: { observations: Observation[]; sourceIds?: readonly string[]; }): Observation[]; }>Compile a projection that keeps only the sources a caller asked to see.
No selection retains the complete evidence; a selection narrows registered source-bearing results. Observations whose tool has no provider pass through untouched, so the projection can only ever remove sources it knows how to name.
| Type parameter | Constraint | Default type |
|---|---|---|
Observation | — | — |
Source | — | — |
| Parameter | Type | Passing | Description |
|---|---|---|---|
definition | EvidenceProjectionDefinition<Observation, Source> | Required | — |
Fields of definition
| Field | Type | Required | Description |
|---|---|---|---|
providers | Readonly<Record<string, EvidenceProjectionProvider<Observation, Source>>> | Required | Read-only. One provider per tool id; observations without a provider pass through unchanged. |
sourceId | (source: Source) => string | Required | Read-only. Stable citation id for a source. |
toolId | ((observation: Observation) => string) | undefined | Optional | Read-only. Selects the tool id of an observation; defaults to its toolId (or legacy tool) field. |
Returns: Readonly<{ project({ observations, sourceIds, }: { observations: Observation[]; sourceIds?: readonly string[]; }): Observation[]; }>.
Return value structure
| Field | Type | Required | Description |
|---|---|---|---|
project | ({ observations, sourceIds, }: { observations: Observation[]; sourceIds?: readonly string[]; }) => Observation[] | Required | See the type definition and usage context. |
Examples
- Evidence: check completeness with real observations: Check requirements against App-defined evidence semantics instead of treating a model saying it is done as a real receipt.
Check whether real material has been read
Beginner · Node.js
ts
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' }] }));js
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' }] }));Return gaps from the same checklist, then limit the sources used for review
Configuration · Node.js
ts
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'] }));js
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'] }));