CalmLens Java 脚本 SDK
JavaScript 和 TypeScript SDK 的官方版本 冷静:内容中和文本、图像、文件和网站的分类,加上可选存储和CDN发送.
安装
npm install calmlens
同一软件包也作为 @calmlens/sdk,在同一版本中。 从您安装的名称导入 : calmlens/server 与 calmlens,或 @calmlens/sdk/server 与 @calmlens/sdk。 。 。 .
该软件包有2个客户端,每个客户端都有自己的导入功能:
| 导入 | 客户端 | 运行 | 认证 |
|---|---|---|---|
calmlens/server | CalmLensServerClient | 在您的服务器上: Node.js 22 或以后, Bun, Deno, Cloudflare 工人 | 项目 API 密钥 |
calmlens/app | CalmLensAppClient | 在浏览器和回放原生应用程序中 | 上传预设, 可选从服务器上传令牌 |
API 密钥,所以 CalmLensServerClient 拒绝在网页或应用程序中开始 。 从浏览器和应用程序上传 CalmLensAppClient,并用签名的URL向他们提供私人内容。 包装了ES模块和带有类型声明的CommonJS. 主语, /server 财务报告和审定财务报表 /app 切入点运行时没有装入其他包. 软件包取决于 zod,其类型声明和测试助手使用,以及 pdfjs-dist 财务报告和审定财务报表 hls.js,而 UI 查看者只在显示文档或流时才会加载.
版本遵循语义版本:参见 版本和支持。 。 。 .
快开始
在下面创建 API 密钥 开发者 — API 密钥 在CalmLens门户。 同一页显示你 项目标识保留在服务器上 .
import { CalmLensServerClient } from "calmlens/server";
const client = new CalmLensServerClient({
apiKey: process.env.CALMLENS_API_KEY!,
projectId: process.env.CALMLENS_PROJECT_ID!,
});
// Text (comments, captions, bios): waits for the decision
const comment = await client.text.classify({ text: "Great photo!", externalId: "comment-42" });
const { status } = comment.classification.moderation;
if (status === "allowed" || status === "limited") {
// publish it; keep "limited" out of recommendations, trending and notifications
} else {
// "age-restricted": show it only behind your own age check; "blocked" or "purged": don't publish it
}
// Images and documents: queued, resolved by webhook or assets.retrieve()
const image = await client.assets.create({
name: "photo.jpg",
content: { data: file, type: "image/jpeg" },
externalId: "post-7",
});
console.log(image.classification.status, image.classification.moderation.status); // "processing" "pending"
classification.status | classification.moderation.status | 含义 |
|---|---|---|
completed | allowed | 安全显示. |
completed | limited | 送来了一样 allowed; 缩小其范围,如不建议. |
completed | age-restricted | 仅交付 viewerClaims.ageConfirmed=true。仅向年龄检查的观众展示. |
completed | blocked | 你的政策阻止了它;CDN不提供. 别显. |
completed | purged | 你的政策阻止了它 并删除了它的内容。 别显. |
queued 或者说 processing | pending | 仍在接收或保密. |
failed | pending | 处理失败; 参见 assets.retry。 。 。 . |
最新应用审查 classification.moderation.manualReviews 优先于自动决定。 处理一个你不承认的状态 见 如何冷静Lens的工作。 。 。 .
尽你所能
- 中度文本,包括: 谈话中的答复,以及 对图像、文件、音频、视频和网站进行分类。 。 。 .
- 读取分类结果 按类别和修饰语 要求提供完整的政策证据 背后的决定.
- 发送 多段上传 对于大文件, 从任意 内容有效载荷,与 安全重试和一能键。 。 。 .
- 从浏览器和应用程序上传 结束 上传预设 并在当地签名 上传符号。 。 。 .
- 掉进去 上传部件和媒体组件 用于反应、反应原生、Vue、Svelte或自定义元素.
- 从CDN交付资产 与 镜头和变相, (中文(简体) ), 已签名的 URL 财务报告和审定财务报表 观众索赔。 。 。 .
- 记录 审查者的决定, (中文(简体) ), 重试失败的处理,以及 在文件夹中组织资产。 。 。 .
- 校验和解析webhooks,或调查 事件种子。 。 。 .
- 处理错误 根据稳定代码,并设置 暂停和请求预算。 。 。 .
- 在代码中管理配置数字 :
uploadPresets.ensure, (中文(简体) ),projectSettings.get编号 :update财务报告和审定财务报表metadataFields.ensure,每个修改所保护的,或宣布项目在calmlens.config.json运行calmlens plan财务报告和审定财务报表calmlens apply在中央情报局. - 将事件转发给带捆绑的本地处理者
calmlens国 际数字 :npx calmlens listen --forward-to http://localhost:3000/api/webhooks/calmlens。 。 。 .
每个公共SDK操作都接受一个选项对象,因此随着可选字段被添加,呼叫站点保持稳定. 这个 SDK 参考 列出每个选项和方法.
测试
calmlens/testing 在模拟 CalmLens API 和 CDN 中运行真实的客户端, 并取得适度的结果, 记录请求, 注入失败并签名 Webhook 交付 。 见 Java 脚本测试。 。 。 .
calmlens/test-inputs 制作签名的测试代码和图像,这些代码和图像是按您选择的情景为温和派签名的。 一个代码只算整个文本,一个图像只算整个上传. 见 生成测试输入。 。 。 .