superagent

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• Node.js 环境（README 给出 TypeScript 用法示例，包名 safety-agent）
• Python 环境（README 给出 Python 用法示例，包名 safety_agent）
• 需自行访问官方文档 https://docs.superagent.sh 获取安装方式

安装与启动步骤

1. 1查阅官方文档

   README 节选未提供安装命令，先到官网文档确认对应语言 SDK 的安装方式与最新用法。

2. 2初始化客户端

   TypeScript 从 safety-agent 导入 createClient 并调用；示例中未传入任何参数。

   import { createClient } from "safety-agent";
   
   const client = createClient();

   复制

3. 3调用 guard 检测

   把用户输入传给 client.guard，返回结果包含 classification 字段。

   const result = await client.guard({
     input: userMessage
   });

   复制

4. 4处理阻断结果

   classification 为 block 表示命中违规，可从 violation_types 读取违规类型。

   if (result.classification === "block") {
     console.log("Blocked:", result.violation_types);
   }

   复制

5. 5Python 端调用

   Python 版本从 safety_agent 导入 create_client，同样 await 调用 guard 并判断结果。

   from safety_agent import create_client
   
   client = create_client()
   
   result = await client.guard(input=user_message)
   
   if result.classification == "block":
       print("Blocked:", result.violation_types)

   复制

如何确认成功

运行 guard 后能拿到返回结果即调用成功，classification 为 block 时表示检测并阻断了风险输入。

常见问题

注意事项

• README 节选未包含安装命令与配置项，安装和鉴权方式必须以官方文档为准，本教程未虚构包安装命令。
• 示例中的 userMessage 需替换为你自己应用里的真实用户输入。
• README 还提到 Redact（PII/PHI/密钥脱敏）等能力，但节选内容被截断，未给出完整示例。
• 项目官网 https://superagent.sh，文档 https://docs.superagent.sh。