# @framers/agentos-ext-topicality 中文文档

规范地址：https://npmcn.com/package/%40framers/agentos-ext-topicality/

版本：0\.2\.5
npm 元数据更新时间：2026-11-10T12:09:32.593Z
中文译文更新时间：2026-11-15T12:23:39.339Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40framers/agentos-ext-topicality
原文对照：https://npmcn.com/package/%40framers/agentos-ext-topicality/?lang=original
项目主页：https://agentos.sh/
源码仓库：https://github.com/manicinc/voice-chat-assistant

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：158 kB，40 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@framers/agentos \>=0\.7\.0
- 首次发布：2026-03-21T23:06:26.916Z
- 最新版本发布：2026-11-10T12:09:32.347Z
- 近 30 天下载量：20277（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

AgentOS的专题执行护栏——基于/基于LLM回落的外置探测

## 安装

```sh
npm install @framers/agentos-ext-topicality
```

也可以使用：`pnpm add @framers/agentos-ext-topicality`、`yarn add @framers/agentos-ext-topicality`、`bun add @framers/agentos-ext-topicality`

## README

# @ framers/ agentos- ext- 专题性

嵌入基于/非主题检测护栏 [`@framers/agentos`](https://github.com/framerslab/agentos),可选的LLM在模棱两可的情况下倒置.

## 它会做什么

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

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

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

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

## 安装

```bash
npm install @framers/agentos-ext-topicality
```

这个包是AgentOS扩展包. 它期望 [`@framers/agentos`](https://github.com/framerslab/agentos) 作为同伴的依赖.

## 快速启动

```ts
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,
      },
    ],
  },
});
```

## 没有话题或一个列表

```ts
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`](https://npmcn.com/package/%40framers/agentos-ext-topicality/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模型和端到端的走过,见 [扩展如何保持可选和懒惰](https://docs.agentos.sh/extensions#how-extensions-stay-optional-and-lazy) 编辑 [自动加载指南](https://docs.agentos.sh/extensions/auto-loading)。 。 。 .

## 许可证

Apache 2. 0 — 见 repo 根 [自由主义](https://npmcn.com/package/LICENSE)。 。 。 .

## 常见问题

### @framers/agentos-ext-topicality 是什么？

AgentOS的专题执行护栏——基于/基于LLM回落的外置探测

### 如何安装 @framers/agentos-ext-topicality？

在项目目录运行 npm install @framers/agentos-ext-topicality，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@framers/agentos（\>=0\.7\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @framers/agentos-ext-topicality 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @framers/agentos-ext-topicality 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @framers/agentos-ext-topicality 可以商用吗？

@framers/agentos-ext-topicality 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @framers/agentos-ext-topicality 的下载量有多少？

根据 npm 官方下载统计，@framers/agentos-ext-topicality 在 2026/10/16 – 2026/11/14 这 30 天内被下载 20,277 次，日均约 676 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @framers/agentos-ext-topicality 还在维护吗？

最新版本 0\.2\.5 发布于 2026/11/10（5 天前）；至今共发布 6 个版本，其中过去 12 个月发布了 6 个；首次发布于 2026/03/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

