@botpoison/node

中文文档
0.3.1发布于 2026/11/05TypeScriptESM + CJS零依赖近 30 天下载 3354

Botpoison for Node.js:验证挑战解决方案,并将格式信息分类为垃圾邮件或带有分类的清洁信息,来自您的服务器. 无依取相.

中文使用文档
文档目录7 节
  1. 挑战
  2. 分类
  3. 模型
  4. 错误
  5. 超时
  6. 测试
  7. 文档

@ botpoison/ 节点

服务器库 博特波伊森语Name它有两种工作:

  • 挑战:验证表单发送的溶解,所以从一个 跳过谜题的脚本被移走 。 浏览器侧面是 @botpoison/browser。 。 。 .
  • 分类: 发送表单信息返回 spam 或者说 clean 带有 得分,它能亲手捕捉垃圾邮件 模型运行在 Botpoison自己在爱尔兰的AWS账户,分类不存储 请回答.

它需要节点18或更晚,并且没有依赖关系. 钥匙来自项目 打开 (原始内容存档于2017-10-26). botpoison.com,这是自由开始,和一个 项目的秘密密钥与两种产品一起工作.

npm install @botpoison/node

挑战

const Botpoison = require("@botpoison/node");
// or: import Botpoison from "@botpoison/node";

const botpoison = new Botpoison({
  secretKey: process.env.BOTPOISON_SECRET_KEY,
});

const { ok } = await botpoison.verify(req.body._botpoison);
if (!ok) {
  return res.status(403).end();
}

verify 当无法联系到Botpoison时拒绝回答 ok: false 带消息 Internal server error 当错误发生在Botpoison的身上 边 决定你的表格 与那些提交, 决不接受一个 丢失的 _botpoison每一个机器人都会发出这样的信号. verify 设置无 自己超时,把它包起来 见 图书馆参考文献。 。 。 .

分类

标签为表单提交 spam 或者说 clean有分数.

const botpoison = new Botpoison({
  secretKey: process.env.BOTPOISON_SECRET_KEY,
});

// The whole form, as your server received it.
const result = await botpoison.classify(req.body, { model: "spam-standard" });
// { label: "clean", score: 0.04, model: "spam-standard" }

if (result.label === "spam") {
  // drop it
}

label 是Botpoison的建议切入 score数字 : spam 从0.8起, clean 在它下面,所以 两人从来没有异议。 行动起来 label 默认值.

score 用于自定义阈值和审查队列。 它从0到1,是 没有概率。 随着模型的更新,它的两分保持固定. 这个 垃圾邮件标签旗 大约1分 1分 1分 0分 1分 1分 100分 好消息得分为0.5分或更多,这让0.5成为共同的起始地 为一个人保存信息。 我们的交通量都算在内 引用设置在一起; 单个站点本身的费率通常为数倍 更高, 请在调制时记录分数 :

if (result.label === "spam") {
  // drop it
} else if (result.score >= 0.5) {
  // hold it for a person
}

表格中没有任何内容, 例如只使用电子邮件的注册, 答案 clean 得分为0 除非模特很有信心是垃圾邮件.

第一个论点是内容:用于单个信息框的字符串,或 每个窗体字段有一个条目的对象。 当您有表格时, 发送整个表格 : 名称、电子邮件和其他字段也是信号。 价值可能是字符串, 数字、布尔或列表;拒绝嵌入对象。 其 名称开始于 _ 被忽略,所以窗体控件如 _redirect 可以留下来 进来 呈文最多可保留100个字段和20,000个字符.

await botpoison.classify("Hi, do you ship to Belgium?", {
  model: "spam-standard",
});

第二个论点是: model 和可选 timeout。 。 。 .

模型

model 命名要分类的模型. spam-standard 唯一的模式 今时. Botpoison更新了它的位置,并且 result.model 命名模式 回答过 一个未知的型号被拒绝,其中400个型号列出了有效的型号.

错误

classify 以 Botpoison.ClassifyError,其 code 说什么 失败 :

code含义
httpAPI回答错误. status 财务报告和审定财务报表 message 说为什么.
timeout没有及时得到答复.
network在答复到来之前,请求失败.
invalid_responseAPI用一个不是分类的躯体回答200.

body 拥有解析的响应机构。 503意味着 暂时无法分类; 决定您的表单是否打开 或关闭而不是重试 在循环.

let result;
try {
  result = await botpoison.classify(message, { model: "spam-standard" });
} catch (error) {
  if (!(error instanceof Botpoison.ClassifyError)) throw error;
  // Fail open: accept the submission unclassified, or queue it for later.
  result = undefined;
}

TypeScript 用户可以导入类型 : ClassifyContent, (中文(简体) ), ClassifyFields, (中文(简体) ), ClassifyFieldValue, (中文(简体) ), ClassifyOptions, (中文(简体) ), ClassifyResult, (中文(简体) ), ClassifyLabel, (中文(简体) ), ClassifyError 财务报告和审定财务报表 ClassifyErrorCode。 。 。 .

超时

电话在默认情况下启动后被放弃了 8000 ms, 然而时间是 已经花光了 代替它每个呼叫:

await botpoison.classify(content, { model: "spam-standard", timeout: 3000 });

测试

使用密钥 test内容 botpoison-test-spam 实值 标签 spam 得分为1, botpoison-test-review 实值 clean 与 0.6分,且 botpoison-test-unavailable 答503号。 还有什么是 clean 得分为0.

文档

版本与发布记录

@botpoison/node 共发布 16 个版本,首次发布于 2021/01/23;过去 12 个月发布了 5 个版本。

版本发布日期距今
0.3.1latest2026/11/053 天前
0.3.02026/10/1821 天前
0.2.02026/10/1821 天前
0.1.122026/08/312 个月前
0.1.112026/07/303 个月前
0.1.102021/10/215 年前

关于 @botpoison/node 的常见问题

@botpoison/node 是什么?

Botpoison for Node.js:验证挑战解决方案,并将格式信息分类为垃圾邮件或带有分类的清洁信息,来自您的服务器. 无依取相.

如何安装 @botpoison/node?

在项目目录运行 npm install @botpoison/node,或使用 pnpm add / yarn add / bun add。

@botpoison/node 支持 TypeScript 吗?

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

@botpoison/node 支持 ESM 还是 CommonJS?

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

@botpoison/node 需要什么版本的 Node.js?

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

@botpoison/node 可以商用吗?

@botpoison/node 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@botpoison/node 的下载量有多少?

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

@botpoison/node 还在维护吗?

最新版本 0.3.1 发布于 2026/11/05(3 天前);至今共发布 16 个版本,其中过去 12 个月发布了 5 个;首次发布于 2021/01/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。