createScopeRegistry
KIT · function · 运行时值
Create and seal a complete catalog; use the constructor for incremental installation.
导入
ts
import { createScopeRegistry } from '@jangts/agent-core/kits/domains';js
import { createScopeRegistry } from '@jangts/agent-core/kits/domains';其他公开入口:@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/kits/domains、@jangts/agent-core/kits。
定义
泛型参数
| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Definition | ScopeDefinition | — |
调用
ts
createScopeRegistry<Definition extends ScopeDefinition>(definitions: Iterable<Definition>, policy?: ScopeRegistryPolicy<Definition>): ScopeRegistry<Definition>Create and seal a complete catalog; use the constructor for incremental installation.
| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Definition | ScopeDefinition | — |
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
definitions | Iterable<Definition> | 必需 | — |
policy | ScopeRegistryPolicy<Definition> | 可省略 | — |
policy 的字段
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
requireGoals | boolean | undefined | 可省略 | 只读。Require at least one Tool id per scope. |
requireSources | boolean | undefined | 可省略 | 只读。Require at least one query scope or knowledge topic per scope. |
requireTools | boolean | undefined | 可省略 | 只读。Require at least one tool id per scope. |
idPattern | RegExp | undefined | 可省略 | 只读。Pattern every id and alias must match. |
categories | readonly string[] | undefined | 可省略 | 只读。Allowed category values; undefined accepts any value. |
assertDefinition | ((definition: Definition) => void) | undefined | 可省略 | 只读。Extra App assertion, called after the built-in checks; must return void synchronously. |
acceptsTool | ((definition: Readonly<Definition>, goal: string) => boolean) | undefined | 可省略 | 只读。Replaces the default intent membership test; must return boolean synchronously. |
tags | readonly string[] | undefined | 可省略 | 只读。Diagnostic tags attached to registration rejections. |
errors | { readonly sealed?: BreakReason; readonly invalid?: BreakReason; } | undefined | 可省略 | 只读。见类型定义及调用场景。 |
返回: ScopeRegistry<Definition>。
使用示例
- Domain Tools:Tool 声明与范围关系:同一清单提供可用 Tool、允许 delegate、范围别名、来源和工具关系。
先登记一个接口说明 Tool
入门 · Node.js
ts
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = IntentRegistry.create([
{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: true },
]);
console.log(tools.ids(), tools.allows('explain', 'read'));
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge' },
]);
console.log(scopes.require('sdk').knowledgeTopicIds);js
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = IntentRegistry.create([
{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: true },
]);
console.log(tools.ids(), tools.allows('explain', 'read'));
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge' },
]);
console.log(scopes.require('sdk').knowledgeTopicIds);增加约束和范围关联,查询入口保持一致
配置 · Node.js
ts
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = new IntentRegistry({ idPattern: /^[a-z-]+$/, delegates: ['read', 'reply'] })
.registerAll([{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: '用户希望了解 SDK 接口或用法。' }]).seal();
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge', aliases: ['agent-core'], goalIds: ['explain'], knowledgeTopicIds: ['manual'], toolIds: ['read-source'] },
], { categories: ['knowledge'], requireGoals: true, requireSources: true });
console.log(tools.describe(), scopes.normalize('agent-core'));
console.log(scopes.acceptsTool('agent-core', 'explain'), scopes.topics('sdk'));js
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = new IntentRegistry({ idPattern: /^[a-z-]+$/, delegates: ['read', 'reply'] })
.registerAll([{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: '用户希望了解 SDK 接口或用法。' }]).seal();
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge', aliases: ['agent-core'], goalIds: ['explain'], knowledgeTopicIds: ['manual'], toolIds: ['read-source'] },
], { categories: ['knowledge'], requireGoals: true, requireSources: true });
console.log(tools.describe(), scopes.normalize('agent-core'));
console.log(scopes.acceptsTool('agent-core', 'explain'), scopes.topics('sdk'));