ArtifactReference
KIT · interface · 类型合同
References locate artifacts; only the App resolver establishes access and current validity.
导入
ts
import type { ArtifactReference } from '@jangts/agent-core/kits/artifacts';js
/** @typedef {import('@jangts/agent-core/kits/artifacts').ArtifactReference} ArtifactReference */其他公开入口:@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/kits、@jangts/agent-core/kits/artifacts。
定义
ts
interface ArtifactReference字段结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
resolverId | string | 必需 | 只读。Resolver that owns the artifact namespace. |
artifactId | string | 必需 | 只读。Artifact identity inside that namespace; never blank. |
revision | string | undefined | 可省略 | 只读。Optional pinned revision; omission asks the resolver for its current revision. |
使用示例
- Artifacts:按引用解析真实产物:引用只包含 resolverId、artifactId 和可选 revision,真实内容由 App 的解析器提供。
先解析一个明确的内存产物
入门 · Node.js
ts
import { Artifacts } from '@jangts/agent-core/kits/artifacts';
const content = new Map([['manual', { text: 'Agent Core 使用说明', revision: '1' }]]);
const artifacts = Artifacts.defineArtifactCatalog([
{ id: 'document', resolve(reference) { const value = content.get(reference.artifactId); if (!value) throw new Error('产物不存在'); return value; } },
]);
const result = await artifacts.resolve({ resolverId: 'document', artifactId: 'manual' }, { app: {}, signal: new AbortController().signal });
console.log(result.text);js
import { Artifacts } from '@jangts/agent-core/kits/artifacts';
const content = new Map([['manual', { text: 'Agent Core 使用说明', revision: '1' }]]);
const artifacts = Artifacts.defineArtifactCatalog([
{ id: 'document', resolve(reference) { const value = content.get(reference.artifactId); if (!value)
throw new Error('产物不存在'); return value; } },
]);
const result = await artifacts.resolve({ resolverId: 'document', artifactId: 'manual' }, { app: {}, signal: new AbortController().signal });
console.log(result.text);相同 resolve 增加真实权限与版本核对
配置 · Node.js
ts
import { Artifacts } from '@jangts/agent-core/kits/artifacts';
type Value = { text: string; revision: string };
type App = { canRead: boolean; documents: Map<string, Value> };
const artifacts = Artifacts.defineArtifactCatalog<Value, App>([
{ id: 'document', async resolve(reference, { app, signal }) {
signal.throwIfAborted();
if (!app.canRead) throw new Error('没有产物读取权限');
const value = app.documents.get(reference.artifactId);
if (!value) throw new Error('产物不存在或已到期');
if (reference.revision && reference.revision !== value.revision) throw new Error('产物版本已变化');
return structuredClone(value);
} },
]);
const app = { canRead: true, documents: new Map([['manual', { text: 'Agent Core 使用说明', revision: '1' }]]) };
console.log(await artifacts.resolve({ resolverId: 'document', artifactId: 'manual', revision: '1' }, { app, signal: new AbortController().signal }));js
import { Artifacts } from '@jangts/agent-core/kits/artifacts';
const artifacts = Artifacts.defineArtifactCatalog([
{ id: 'document', async resolve(reference, { app, signal }) {
signal.throwIfAborted();
if (!app.canRead)
throw new Error('没有产物读取权限');
const value = app.documents.get(reference.artifactId);
if (!value)
throw new Error('产物不存在或已到期');
if (reference.revision && reference.revision !== value.revision)
throw new Error('产物版本已变化');
return structuredClone(value);
} },
]);
const app = { canRead: true, documents: new Map([['manual', { text: 'Agent Core 使用说明', revision: '1' }]]) };
console.log(await artifacts.resolve({ resolverId: 'document', artifactId: 'manual', revision: '1' }, { app, signal: new AbortController().signal }));