@ framers/ agentos- ext- 专题性

嵌入基于/非主题检测护栏 @framers/agentos,可选的LLM在模棱两可的情况下倒置.

它会做什么

将收到的用户信件与配置的专题政策进行比较。 它只检查输入:代理输出通过. 接近被屏蔽主题的输入被屏蔽;接近任何被允许主题的输入被标记为非主题.

每个输入都到第一层,答案是:

1. 入内入地. 铁道进口 @huggingface/transformers (可选依赖),载荷 Xenova/all-MiniLM-L6-v2 将同位素的相近性与每个专题相比较 maxBlockedSimilarity (违约0.5)和 minSimilarity (默认0.3). 当软件包丢失或模型无法加载时,每个守护符会写出一个带有错误的警告,代之以它使用的级别(参见 日志),并进入下一层.
2. LLM评委. 当你通过一个 llmInvoker 回话,看守员要求模型做出JSON判决. 失败的呼叫会进入下一关 .
3. 关键词. 输入和每个话题字符串之间的大小写不敏感子字符串匹配,总是可用的.

用它来保持一个客户支持代理在产品的域.

安装

npm install @framers/agentos-ext-topicality

这个包是AgentOS扩展包. 它期望 @framers/agentos 作为同伴的依赖.

快速启动

import { AgentOS } from '@framers/agentos';
import { createTopicalityGuardrail } from '@framers/agentos-ext-topicality';

const agentos = new AgentOS();
await agentos.initialize({
  extensionManifest: {
    packs: [
      {
        factory: () =>
          createTopicalityGuardrail({
            allowedTopics: ['product support', 'billing', 'account access'],
            blockedTopics: ['politics'],
            minSimilarity: 0.3,
          }),
        enabled: true,
      },
    ],
  },
});

没有话题或一个列表

createTopicalityGuardrail(); // or a manifest entry with no options
// first input: topicality: no allowedTopics or blockedTopics configured, so this guardrail passes every input

一个包都没有 allowedTopics 也没有 blockedTopics (一个没有选择权的明细条目,或仅包含优先权和秘密的扩展登记册的选项)传递了每一项输入。 在它的第一个输入上,它写上面的行一次,通过记录器,主机通过在包上下文,否则激活上下文,否则是控制台.

单凭一份清单即可强制执行: blockedTopics 单独屏蔽匹配输入并让其余输入通过; allowedTopics 仅标出一个没有匹配的输入 .

日志

当嵌入级无法加载时, 每个守护符会写出一行 :

topicality: the embedding tier is unavailable (Xenova/all-MiniLM-L6-v2 could not load: <error>); deciding with the keyword tier

和关于缺失话题的行一样,它会转到主机在包上下文所经过的日志机,或者激活上下文,或者控制台.

公共 API

• TopicalityGuardrail 执行AgentOS警卫合同的警卫班
• CheckTopicTool - 工具代理人可以要求看守员作出明确决定
• createTopicalityGuardrail(options) 工厂归还 ExtensionPack
• createExtensionPack(context) ——AgentOS扩展设备使用的可自动发现工厂自动取出
• cosineSimilarity, (中文(简体) ), clearEmbeddingCache - 直接使用的公用事业

见 src/types.ts 用于完整选项形状(TopicalityOptions) (中文(简体) ).

实例

• test/ 单位测试,显示阈值调和后退行为

懒惰装入和可选安装

此软件包是 @framers/agentos-extensions-registry登记册船舶目录元数据; createCuratedManifest() 电话 import.meta.resolve() 每个条目并默默跳过任何未安装的条目. npm install @framers/agentos-ext-topicality 是大门.

激活时没有负载 铁道进口 @huggingface/transformers 并加载其检查的第一个输入的嵌入模型。 嵌入每个文本在内存中被缓存; clearEmbeddingCache() 空出缓存, 和包叫它关闭.

LLM 级仅在您通过时运行 llmInvoker。 。 。 .

护栏登记员 config.canSanitize = false 财务报告和审定财务报表 config.evaluateStreamingChunks = false:它从不重写文本,在双相调度器(相位分类器)的第二阶段运行. 被封杀的专题匹配返回 BLOCK; 非专题输入返回 FLAG。 。 。 .

关于完整的DI模型和端到端的走过,见 扩展如何保持可选和懒惰 编辑 自动加载指南。 。 。 .

许可证

Apache 2. 0 — 见 repo 根 自由主义。 。 。 .