# @bulkhead-ai/core 中文文档

规范地址：https://npmcn.com/package/%40bulkhead-ai/core/

版本：0\.9\.1
npm 元数据更新时间：2026-07-27T16:49:52.703Z
中文译文更新时间：2026-11-08T23:36:17.294Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bulkhead-ai/core
原文对照：https://npmcn.com/package/%40bulkhead-ai/core/?lang=original
项目主页：https://github.com/floatingsidewal/bulkhead#readme
源码仓库：https://github.com/floatingsidewal/bulkhead

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

- 包体积（解压后）：1 MB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- peer 依赖：@huggingface/transformers ^3\.0\.0
- 首次发布：2026-04-12T14:20:41.022Z
- 最新版本发布：2026-07-27T16:49:52.302Z
- 近 30 天下载量：1999（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

分解内容保护引擎——PII检测,秘密扫描,即时注射防护

## 安装

```sh
npm install @bulkhead-ai/core
```

也可以使用：`pnpm add @bulkhead-ai/core`、`yarn add @bulkhead-ai/core`、`bun add @bulkhead-ai/core`

## README

# 散头核心

分解内容保护引擎 - 检测和编辑PII,秘密,即时注射,以及系统在到达LLMS前迅速漏出文本.

部分 [散头](https://github.com/floatingsidewal/bulkhead) 项目.

## 安装

```bash
npm install @bulkhead-ai/core
```

也可用 `@floatingsidewal/bulkhead-core` 通过 [GitHub 软件包](https://github.com/floatingsidewal/bulkhead/packages)。 。 。 .

## 快速启动

```typescript
import { createEngine } from "@bulkhead-ai/core";

const engine = createEngine();

// Fast regex-only scan (sub-millisecond)
const result = await engine.analyze("My SSN is 123-45-6789 and key is AKIAIOSFODNN7EXAMPLE");

console.log(result.passed);      // false
console.log(result.detections);   // [{ entityType: "US_SSN", ... }, { entityType: "AWS_ACCESS_KEY", ... }]

// Scan and redact
const redacted = await engine.scan("Call me at 555-867-5309");
console.log(redacted.redactedText); // "Call me at [REDACTED-US_PHONE]"
```

## 使 JSON 兼容文档具有安全性

`sanitizeDocument()` 是推荐对象和数组的 API。 它扫描 在突变前按键和字符串值,一次解决重叠检测, 为文档使用一个一致性地图和时间锁定,以及报告 与后处理安全分开进行预处理检测.

```typescript
import { sanitizeDocument } from "@bulkhead-ai/core";

const result = await sanitizeDocument(
  {
    contact: "person@example.com",
    opened: "2026-07-10",
    events: [{ occurred: "07/12/2026" }],
  },
  "eval",
  { localizedDateOrder: "mdy" },
);

if (!result.metadata.postTreatment.safe ||
    !result.metadata.postTreatment.structurallyValid) {
  throw new Error("Sanitization boundary rejected output");
}

console.log(result.value);
console.log(result.metadata.detectedRisk);
```

本地化的日期需要明确 `mdy`, (中文(简体) ), `dmy`,或 `reject-ambiguous` 选择。 被检测到的模糊、无效或不支持的日期被替换 与 `[REDACTED-DATE_TIME]` 而不是没有变化地通过.

## 它检测到什么

| 类别 | 覆盖范围 |
| --- | --- |
| **临 二** | 20多个国家的45个以上实体类型(SSN、信用卡、IBAN、电话、电子邮件、医疗身份证、国家身份证) |
| **秘诀** | 共有13个类别(AWS、Azure、GCP、GitHub、Slack、Frede、数据库证书、私人密钥)的154种模式 |
| **快速注射** | 16+模式(角色游戏攻击,DAN模式,指令覆盖) |
| **系统急漏** | 7+图案(即时取出,"重复上面的一切") |

所有结构模式都酌情包括验收和验证(Luhn, IBAN mod-97, Verhoeff).

## 策略扫描

```typescript
import { createEngine, getPolicy } from "@bulkhead-ai/core";

const engine = createEngine({
  enabled: true,
  debounceMs: 500,
  guards: {
    pii: { enabled: true },
    secret: { enabled: true },
    injection: { enabled: true },
    contentSafety: { enabled: false },
  },
  cascade: {
    modelEnabled: false,
    escalationThreshold: 0.75,
    contextSentences: 3,
    modelId: "Xenova/bert-base-NER",
  },
  policy: "strict",
});

const policy = getPolicy("strict");
const { risk } = await engine.policyScan(inputText, policy);
console.log(risk.level);        // "critical" | "high" | "medium" | "low" | "none"
console.log(risk.issues);       // classified issues by category and severity
console.log(risk.testDataFlags); // synthetic/eval data detected
```

## BERT 层( 可选)

名称、地点和组织等背景实体:

```bash
npm install @huggingface/transformers
```

```typescript
const engine = createEngine({
  // ...
  cascade: { modelEnabled: true, /* ... */ },
});

const result = await engine.deepScan("Send the report to John Smith at Acme Corp");
```

BERT模型(~29 MB)在第一推论上下载并用工人线程运行. 没有要求 GPU .

## 文档

见 [如何向导](https://github.com/floatingsidewal/bulkhead/blob/develop/docs/how-to.md) 关于综合实例和 [完整文档](https://github.com/floatingsidewal/bulkhead/tree/develop/docs) 用于架构、部署和API参考.

## 许可证

麻省理工学院

## 常见问题

### @bulkhead-ai/core 是什么？

分解内容保护引擎——PII检测,秘密扫描,即时注射防护

### 如何安装 @bulkhead-ai/core？

在项目目录运行 npm install @bulkhead-ai/core，或使用 pnpm add / yarn add / bun add。

### @bulkhead-ai/core 支持 TypeScript 吗？

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

### @bulkhead-ai/core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bulkhead-ai/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bulkhead-ai/core 可以商用吗？

@bulkhead-ai/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bulkhead-ai/core 的下载量有多少？

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

### @bulkhead-ai/core 还在维护吗？

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