京东开源的大模型安全框架 JoySafety

https://github.com/jd-opensource/JoySafety

JoySafety —— 大模型安全框架

📋 目录

项目简介
✨ 特性
🚀 快速开始
📖 使用指南
🏆 最佳实践
🏗️ 架构设计
🛠️ 开发
📄 许可证
📅 计划
Star History

<a id="项目简介"></a>项目简介

随着生成式人工智能应用的广泛落地，内容安全、数据泄露、提示词攻击等风险也日益凸显。如何保障大模型输出符合法规要求、避免安全漏洞，已成为企业必须面对的关键挑战。为此，京东正式开源大模型安全框架——JoySafety，该框架在京东内部广泛应用，覆盖AI导购、物流客服、销售助手、医疗问诊、商家工作台、法务咨询、安全问答等场景，支持日均亿级调用、95%+攻击拦截率，致力于为企业提供一套成熟、可靠、免费的大模型安全防护方案。

✨ <a id="特性"></a>特性

🚀 生产级别

企业级实战验证

✅ 保障京东多个生产级AI应用安全稳定运行
✅ 复杂业务场景验证，持续迭代优化
✅ 服务部署支持横向扩展，满足高并发业务需求
✅ 业务接入零门槛，策略变更支持分钟级热更新

高可靠性保障

🔄 原子能力热插拔，业务不中断
⚡ 配置动态生效，快速响应业务变化
📊 生产环境长期稳定性验证

📈 高扩展性

灵活的架构设计

🧩 支持多种原子能力模块（BERT/FastText/Transformer等主流模型）
🔌 标准化原子能力接口，易于扩展新模型
🏗️ 支持独立部署或集中部署两种模式
⚙️ 轻量编排引擎，按需灵活配置

智能负载均衡

🌐 集群化部署支持水平扩展
⚡ 异步检测机制，提升并发处理能力
🎯 窗口化检测策略，平衡性能与准确性

💡 易用性

开箱即用

🐳 一键Docker Compose启动，零配置门槛
📱 DAG编排
🔧 标准化API接口，快速集成现有系统

🎯 核心技术亮点

突破性创新

1. 大模型多轮会话智能识别

2. 采用Free-Taxi异步输出模式，大幅提升检测响应，实现用户体验与安全的完美平衡

3. 多维响应策略矩阵

🎯 精准拦截 - 高风险内容即时阻断
⏸️ 红线代答 - 红线知识库应答
🔄 智能纠偏 - 自动引导正向回答

🚀 <a id="快速开始"></a>快速开始

环境依赖

请确保已安装以下软件：

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

0. 克隆项目

  #1.
  git clone https://github.com/jd-opensource/JoySafety.git
  
  #2. 进入项目路径
  cd JoySafety
  
  #3. 设置环境变量（建议复制执行，后续脚本/服务均可自动识别）
  export SAFETY_ROOT_PATH=`pwd`
  #正常为JoySafety 根路径
  echo ${SAFETY_ROOT_PATH}

=======

1. 下载模型文件（Huggingface）

推荐使用 git-lfs 拉取大模型文件


  #进入项目路径
  cd $SAFETY_ROOT_PATH

  #
  git lfs install

  #方案1
  git clone https://huggingface.co/jdopensource/JoySafety ${SAFETY_ROOT_PATH}/data/models

  #方案2
  #因网络问题，您也可以从[ModelScope](https://modelscope.cn/models/syf20240814/joysafety/files)下载，`记得解压fast20250710目录下的zip文件`）

2. 配置 .env 文件

【在项目根路径】复制 .env.example 或手动创建 .env：

   # 注：切换Shell窗口, 重新设置SAFETY_ROOT_PATH
   cd $SAFETY_ROOT_PATH
   
   cp -f .env.example .env
    
   # 测试只需修改.env文件中变量:SAFETY_MODEL_DIR，路径需与模型实际下载路径一致【绝对路径】
   SAFETY_MODEL_DIR=

3. 一键启动（Docker Compose）

   docker-compose --env-file .env up

4. API 测试

详细 API 测试案例及使用说明移步到 quickstart/README.md。

请参考 quickstart 目录下的文档，获取最新的 API 测试脚本和案例说明。

📖 <a id="使用指南"></a>使用指南

API 接口调用

参考 API 文档

多语言调用

动态配置

业务管理参考： business_api.md
原子能力管理参考： function_api.md
策略编排参考：dag_api.md、策略样例

FAQ

常见问题与解决方案见 FAQ

基于产品特性，项目中的示例仅用于产品功能说明使用，不得用于其他领域，非项目开发者观点。

<a id="最佳实践"></a>🏆最佳实践

最佳实践见best_practice.md

🏗️ <a id="架构设计"></a>架构设计

项目目录结构

.
├── README.md
├── deploy
│         ├── docker-compose.yml    // 打包启动服务（各个模块也可以单独启动）
│         └── thirdparty            // 第三方依赖相关配置及文档
│             ├── mysql
│             ├── redis
│             └── vearch
├── safety
│         ├── safety-admin           // 用于管理配置和数据后台服务
│         ├── safety-api             // 对外提供能力的api服务
│         ├── safety-basic            // 核心jar包，服务于safety-admin、safety-basic及safety-demo中的java部分
│         ├── safety-demo            // 使用safety-api的多语言示例
│         │         ├── golang
│         │         ├── java
│         │         └── python
│         └── safety-skills          // safety-api支持的各项技能实现及部署
│             ├── safety-bert        // 用于部署bert模型的服务
│             ├── safety-fasttext    // 用于部署fasttext模型的服务
│             ├── safety-keywords    // 敏感词能力的实现
│             └── safety-knowledge   // 支持知识检索、基于知识的代答以及多轮对话的检测
└── quickstart                      // 用于用户快速体验

技术架构说明

1. 配置时期流程图

仅涉及后台管理、原子能力注册、策略/业务场景配置、数据写入。用户/业务系统不参与，所有配置数据最终写入数据库，供执行时期加载。

flowchart TD
    Quickstart[quickstart/脚本]
    Admin[safety-admin<br/>后台管理]
    Bert[safety-bert<br/>独立服务]
    FastText[safety-fasttext<br/>独立服务]
    Keywords[safety-keywords<br/>独立服务]
    Knowledge[safety-knowledge<br/>独立服务]
    DB[(MySQL/Redis)]
    Vearch[(Vearch 向量库)]
    Strategy[防御策略编排]
    Business[业务场景配置]

    Quickstart-->|初始化/注册|Admin
    Admin-->|注册原子能力|Bert
    Admin-->|注册原子能力|FastText
    Admin-->|注册原子能力|Keywords
    Admin-->|注册原子能力|Knowledge
    Admin-->|敏感词管理|Keywords
    Admin-->|知识库管理|Knowledge
    Admin-->|配置写入|DB
    Admin-->|策略编排|Strategy
    Admin-->|业务场景配置|Business
    Bert-->|模型/配置|DB
    FastText-->|模型/配置|DB
    Keywords-->|敏感词数据|DB
    Knowledge-->|知识/配置|DB
    Knowledge-->|向量检索|Vearch

2. 执行时期流程图

用户/业务系统发起请求，API服务加载数据库配置和策略，调用各 Skill 服务完成检测/处理。safety-admin 不参与执行链路，仅在配置时期写入数据。

flowchart TD
    User[用户/业务系统]
    API[safety-api<br/>API服务]
    Core[safety-basic<br/>Java lib]
    Bert[safety-bert<br/>独立服务]
    FastText[safety-fasttext<br/>独立服务]
    Keywords[safety-keywords<br/>独立服务]
    Knowledge[safety-knowledge<br/>独立服务]
    DB[(MySQL/Redis)]
    Vearch[(Vearch 向量库)]

    User-->|HTTP/SDK|API
    API-->|依赖|Core
    API-->|读策略/配置|DB
    API-->|HTTP/RESTful|Bert
    API-->|HTTP/RESTful|FastText
    API-->|HTTP/RESTful|Keywords
    API-->|HTTP/RESTful|Knowledge
    Bert-->|模型/数据|DB
    FastText-->|模型/数据|DB
    Keywords-->|敏感词数据|DB
    Knowledge-->|知识/配置|DB
    Knowledge-->|向量检索|Vearch

模块依赖关系说明：

safety-api 仅依赖 safety-basic（Java lib），通过数据库获取策略/配置，不依赖 safety-admin。
safety-admin 仅负责后台管理和配置写入数据库，不参与用户请求链路。
各 Skill（safety-bert、safety-fasttext、safety-keywords、safety-knowledge）为独立服务，safety-api 通过 HTTP/RESTful 接口调用。
数据库（MySQL/Redis）和向量库（Vearch）为各服务提供持久化和检索能力。

模块依赖关系说明：

safety-basic 仅作为 Java lib，被 safety-api、safety-admin 等主服务模块依赖，不作为独立服务运行。
各 Skill（safety-bert、safety-fasttext、safety-keywords、safety-knowledge）为独立服务，分别通过 HTTP/RESTful 接口被主服务调用，服务间无直接依赖。
主服务（safety-api、safety-admin）通过 safety-basic 统一能力编排和策略管理，Skill 服务专注于原子能力实现。
数据库（MySQL/Redis）和向量库（Vearch）为各服务提供持久化和检索能力。

主要模块说明

模块	语言	主要功能
safety-admin	Java	配置及数据管理
safety-api	Java	对外 API 服务、策略编排、流式检测
safety-basic	Java	核心库，服务于主服务及 demo
safety-skills/safety-bert	Python	BERT 分类模型服务
safety-skills/safety-fasttext	Python	FastText 分类模型服务
safety-skills/safety-keywords	Java	敏感词检测服务
safety-skills/safety-knowledge	Python	知识检索、RAG、多轮对话检测
quickstart	Python/YAML	快速体验脚本与样例
deploy	Docker	容器化部署与依赖管理

🛠️ <a id="开发"></a>开发

参考各个模块中的README文档

🤝 <a id="贡献"></a>贡献

我们欢迎所有好想法和建议！如果您想成为项目的共建者，可随时提交 Pull Request，同时签署贡献者许可协议(CLA)。
有任何事宜可邮箱联系：[email protected]。

项目共建者

京东集团
贡献者名单见 CONTRIBUTORS.md（待补充）

📄 <a id="许可证"></a>许可证

本项目采用 Apache License 2.0 开源协议，欢迎企业和个人自由使用、修改和二次开发。

<a id="计划"></a>📅计划

JoySafety旨在构建完整大模型安全解决方案，此次开源主要为大模型安全防护能力，后续将陆续推出：

安全审核大模型 在Huggingface平台开源部分安全审核大模型，后续Joysafety集成此系列模型实现大模型风险合规的审计能力

大模型安全评测：针对大模型应用上线前的安全风险检测，覆盖《生成式人工智能服务安全基本要求》中5大类31小类风险类型。

Agent安全防护：包括身份与权限管理、数据与记忆防护、工具与执行安全、MCP代码安全检测、供应链与协议安全等能力。

所有版块