如何快速搭建JoySafety：零基础入门的完整教程

如何快速搭建JoySafety：零基础入门的完整教程

【免费下载链接】JoySafetyJoySafety项目地址: https://gitcode.com/gh_mirrors/jo/JoySafety

JoySafety是京东开源的大模型安全框架，能有效防护内容安全、数据泄露、提示词攻击等风险，支持日均亿级调用，95%+攻击拦截率，为企业提供成熟可靠的大模型安全防护方案。

📋 准备工作：环境依赖检查

在开始搭建JoySafety前，请确保你的系统已安装以下必备软件：

• git
• git-lfs（用于下载模型文件）
• docker
• docker compose

这些工具将帮助你顺利完成后续的安装和部署步骤。

🚀 第一步：克隆项目代码

首先，通过以下命令将JoySafety项目克隆到本地：

git clone https://gitcode.com/gh_mirrors/jo/JoySafety cd JoySafety export SAFETY_ROOT_PATH=`pwd` echo ${SAFETY_ROOT_PATH}

执行成功后，你将看到项目根路径的输出，这表明环境变量设置正确。

📦 第二步：下载模型文件

JoySafety需要一些预训练模型来提供核心功能。推荐使用git-lfs拉取大模型文件：

cd $SAFETY_ROOT_PATH git lfs install git clone https://huggingface.co/jdopensource/JoySafety ${SAFETY_ROOT_PATH}/data/models

如果遇到网络问题，也可以从ModelScope下载模型文件。模型详细说明可参考safety/safety-skills/model_overview.md。

⚙️ 第三步：配置环境变量

在项目根路径下，复制环境变量示例文件并进行必要修改：

cd $SAFETY_ROOT_PATH cp -f .env.example .env

编辑.env文件，将SAFETY_MODEL_DIR设置为模型实际下载路径的绝对路径。

🌟 第四步：一键启动服务

完成上述配置后，使用docker-compose一键启动所有服务：

docker-compose --env-file .env up

这个命令会启动包括safety-api、safety-admin、safety-bert等在内的所有必要服务。首次启动可能需要一些时间下载镜像和初始化数据。

✅ 第五步：验证安装是否成功

服务启动后，你可以通过API测试来验证安装是否成功。详细的API测试案例及使用说明请参考quickstart/README.md。

例如，你可以使用以下命令测试正常文本识别：

docker exec -it safety-knowledge python /work/api_test.py '你好'

如果一切正常，你将看到类似以下的输出：

{ "code": 0, "message": "ok", "cost": 9, "data": [ { "checkedContent": "你好", "riskCode": 0, "riskMessage": "0正常文本", ... } ] }

📚 扩展学习与资源

• API文档：详细的API接口说明请参考safety/safety-api/docs/api.md
• 多语言调用示例：
  • Python: safety/safety-demo/python/demo.py
  • Go: safety/safety-demo/golang/main.go
  • Java: safety/safety-demo/java/src/main/java/com/jd/security/llmsec/demo/DefenseApiDemo.java
• 常见问题：遇到问题可查阅docs/FAQ.md

🤝 加入社区

欢迎加入JoySafety官方交流群，获取最新动态和技术支持：

通过以上步骤，你已经成功搭建了JoySafety大模型安全框架。现在你可以开始探索其强大的安全防护功能，保护你的AI应用免受各种潜在风险的威胁。无论是内容安全检测、敏感词过滤还是提示词注入防护，JoySafety都能为你提供全方位的安全保障。

【免费下载链接】JoySafetyJoySafety项目地址: https://gitcode.com/gh_mirrors/jo/JoySafety