# @desert-ant-labs/redact 中文文档

规范地址：https://npmcn.com/package/%40desert-ant-labs/redact/

版本：4\.3\.0
npm 元数据更新时间：2026-11-05T21:27:47.362Z
中文译文更新时间：2026-11-12T00:58:34.876Z
软件包许可：SEE LICENSE IN LICENSE\.md

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

原始 npm 页面：https://www.npmjs.com/package/%40desert-ant-labs/redact
原文对照：https://npmcn.com/package/%40desert-ant-labs/redact/?lang=original
项目主页：https://desertant.com/models/redact/
源码仓库：https://github.com/Desert-Ant-Labs/desert-ant-core

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

- 包体积（解压后）：176 MB，31 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@litertjs/core \>=2\.1\.0
- 首次发布：2026-07-06T10:35:46.012Z
- 最新版本发布：2026-11-05T21:27:47.170Z
- 近 30 天下载量：16310（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：36（近 12 个月 36 个）

## 中文简介

用于JavaScript的在线多语言PII编辑. 在浏览器(WebAssembly + LiteRT.js)和服务器端(native)运行,从一个导入.

## 安装

```sh
npm install @desert-ant-labs/redact
```

也可以使用：`pnpm add @desert-ant-labs/redact`、`yarn add @desert-ant-labs/redact`、`bun add @desert-ant-labs/redact`

## README

# @ 沙漠- ant- labs/ 红色

用于JavaScript的在线多语言PII编辑. 找到名字,地址, 电子邮件、电话号码、卡片、IBAN、国家身份证和更多27种语言, 完全在当地. [完整语言列表](https://huggingface.co/desert-ant-labs/redact#languages)。 。 。 .

两条共用一条 `Redact` API : (英语)

-   **`@desert-ant-labs/redact`** (默认):一个WebAssembly输油管 [LitteRT.js (法语)](https://www.npmjs.com/package/@litertjs/core) 推论 (XNNPACK默认加速CPU,可选WebGPU),用于 **浏览器**。 没有本地的依赖性,所以每个目标都有一个干净的进口建筑 多目标捆绑机(Next.js、Remix、SvelteKit、Nuxt),包括 浏览器捆绑和客户端-组件 SSR 通过这些框架 节点. 这是安全的 _导入_ 服务器侧渲染时, 但 LiteRT.js 需要 浏览器( 或 Web Worker) 以初始化, 所以 `Redact.load()` 只运行推论 在浏览器中; 在平端节点中调用它 交给你 `/native`。 。 。 .
-   **`@desert-ant-labs/redact/native`**: 预建的本地核心( LiteRT on Linux, 核心ML在macOS上,用于 **服务器侧推论** 在节点。 没有 `@litertjs/core`, (中文(简体) ), 没有建造工具,没有旗帜。 从纯服务器代码( API 路由、 服务器) 导入 动作,普通节点脚本). 不要从同样组件导入它 在浏览器中制作.

```bash
# Browser (default entry):
npm i @desert-ant-labs/redact @litertjs/core

# Server-side inference in Node (/native entry) needs no extra install:
npm i @desert-ant-labs/redact
```

```js
import { Redact } from "@desert-ant-labs/redact";

const redact = await Redact.load();            // downloads the model from HF at the pinned tag, cached
const r = await redact.redaction("Email Anna at anna@example.com.");

r.redactedText;      // "Email [GIVEN_NAME_1] at [EMAIL_1]."
r.items;             // detections: label, original, placeholder, confidence, offsets
const reply = await llm(r.redactedText);       // the LLM sees only placeholders
r.restore(reply);    // originals filled back in

redact.dispose();    // release the model (both builds)
```

纯服务器代码,希望本地核心从中导入相同的 API `/native` 子路径 :

```js
import { Redact } from "@desert-ant-labs/redact/native"; // server only
```

`Redact.load()` 接受:

-   `directory`: 自主机/运行下线的清晰模式目录(本地) 构建, 或浏览器在节点下构建); 文件已经使用而没有 下载,否则模型会被下载到其中. 关闭管理中的缓存 (单位:千美元)`~/.cache/desert-ant-models/...`) (中文(简体) ).
-   `modelBaseUrl` (浏览器构建):您服务于(例如)模型文件的基础URL. `"/assets/redact/"`),而不是为自主机/下线设置而装入了Hugging Face.
-   `cacheRoot`: 管理上磁盘缓存的基础目录(默认) `~/.cache`· ; 本地构建,或浏览器在节点下构建).
-   `onProgress`: 下载进度回调, 分数在 `[0, 1]`。 。 。 .
-   `litert` (浏览器):带来自有的LitERT.js模块(该模块) `@litertjs/core` 命名空间,例如捆绑管理的导入).
-   `litertWasmDir` (浏览器): URL/路径到 LiteRT.js Wasm 文件(默认为 ,或浏览器中的jsDelivr CDN.
-   `accelerator` (浏览器): `"wasm"` (XNNPACK CPU,默认), `"webgpu"`,或 `"webnn"`。 。 。 .

默认模式是 **第一次从 Hugging Face 下载** (单位:千美元) sHA-256经核实,并为 后来运行,所以Npm tarball中没有模型大小的船. 在节点中缓存是 oS 缓存目录; 在浏览器中是获取缓存 。 使用 `directory` (节点)或 `modelBaseUrl` (浏览器)到自主/跑完全下线. `@litertjs/core` 是一个 可选对等者依赖( 仅构建浏览器) .

## 选择被编辑的内容

`redaction(text, options)` 接受:

-   `minimumConfidence`: 神经检测的最低分数( 默认) `0.6`) (中文(简体) ). 结构化识别器(电子邮件,卡片,IBANs,.)始终适用.
-   `labels`:仅限于这些类别。 关闭 `DEFAULT_LABELS`。 。 。 .

`ORG` (公司/组织名称)被发现,但 **未默认编辑**, (中文(简体) ), 因为公司不是自然人 它的存在使得名字像 `Silverfin` 或者说 `Odoo` 被确认为组织,而不是被误标为 (单位:千美元) `SURNAME`。当您想要公司伪装时,请输入:

```js
import { Redact, DEFAULT_LABELS, ALL_LABELS } from "@desert-ant-labs/redact";

await redact.redaction(text, { labels: [...DEFAULT_LABELS, "ORG"] });
await redact.redaction(text, { labels: ["EMAIL", "PHONE"] });  // only these
```

`DEFAULT_LABELS` 财务报告和审定财务报表 `ALL_LABELS` 是两个条目导出被冻结的数组.

## 保险箱和安保部

默认 `@desert-ant-labs/redact` 导入可直接用于 组件: 它是纯 JavaScript + Web Assembly 没有本地模块, 所以 捆绑者可以为浏览器和节点SSR从同一处传出而建 没有配置的模块图.

这个 `@desert-ant-labs/redact/native` 子路径加载本地加通( 通过 `koffi`(中文(简体) ) 并仅用于服务器代码。 如果您在捆绑的框架内导入它 服务器代码(例如 Next.js Route Handler 或 Server Action),标记它 外部, 因此捆绑者不会试图捆绑本地二进制 。 在下一个.js中:

```js
// next.config.js
module.exports = { serverExternalPackages: ["@desert-ant-labs/redact"] };
```

本地服务器为linux-x64,linux-arm64(LiteRT)建造船舶,以及 darwin-arm64 (英语:Core ML). 其他平台在 `load()`· ; 使用默认的 Web Assembly 构建、 Swift 软件包或浏览器.

与Swift套装(iOS/macOS)和Android AAR同为型号的飞船 同一仓库 : [https://github.com/沙漠-安特-拉布斯/沙漠-南-核心](https://github.com/Desert-Ant-Labs/desert-ant-core)

## 许可证

[沙漠蚂蚁实验室 源头可破坏许可证](https://license.desertant.com/)。为大多数免费提供 应用软件和商务许可证必须规模化。 完整的术语在链接. 许可证发放: [许可@ desertant.com](mailto:licensing@desertant.com)。 。 。 .

SDK的第三方通知: [`THIRD_PARTY_NOTICES.md`](https://github.com/Desert-Ant-Labs/desert-ant-core/blob/main/THIRD_PARTY_NOTICES.md)。 。 。 .

权重第三方通知: [`THIRD_PARTY_NOTICES.md`](https://huggingface.co/desert-ant-labs/redact/blob/main/THIRD_PARTY_NOTICES.md)。 。 。 .

## 常见问题

### @desert-ant-labs/redact 是什么？

用于JavaScript的在线多语言PII编辑\. 在浏览器\(WebAssembly \+ LiteRT\.js\)和服务器端\(native\)运行,从一个导入\.

### 如何安装 @desert-ant-labs/redact？

在项目目录运行 npm install @desert-ant-labs/redact，或使用 pnpm add / yarn add / bun add。

### @desert-ant-labs/redact 支持 TypeScript 吗？

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

### @desert-ant-labs/redact 支持 ESM 还是 CommonJS？

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

### @desert-ant-labs/redact 可以商用吗？

@desert-ant-labs/redact 使用 SEE LICENSE IN LICENSE\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @desert-ant-labs/redact 的下载量有多少？

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

### @desert-ant-labs/redact 还在维护吗？

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