开源项目 promptmap 使用指南

1. 项目目录结构及介绍

.
├── LICENSE                # 许可证文件
├── README.md              # 项目说明文档
├── promptmap.py           # 主要执行脚本
├── requirements.txt       # 项目依赖库列表
├── system-prompts.yaml    # 系统提示样本配置文件
└── __pycache__            # Python编译后的缓存文件夹

• LICENSE: 包含项目的MIT许可证详细信息。
• README.md: 提供关于项目目的、功能和如何使用的快速概览。
• promptmap.py: 核心脚本，用于执行自动的prompt注入攻击测试。
• requirements.txt: 列出了运行项目所需的Python包及其版本。
• system-prompts.yaml: 用户自定义或预设的系统级提示配置文件，用于定义ChatGPT实例的行为上下文。
• pycache: 自动生成的Python字节码缓存，非必需但可以优化运行时性能。

2. 项目启动文件介绍

• promptmap.py 此脚本是项目的执行入口。通过运行python3 promptmap.py命令，它将分析您的ChatGPT实例的系统提示，并开始模拟攻击以检测潜在的安全漏洞。支持命令行参数进行定制化配置，如增加尝试的攻击次数等。

3. 项目的配置文件介绍

• system-prompts.yaml 这个YAML文件用于设置您的ChatGPT实例特有的系统响应规则。文件中应包含自定义的系统提示，例如提供的示例展示了如何指定一个聊天机器人的特定行为——回答关于冥想的问题。编辑此文件，可以调整promptmap在测试时所依据的上下文，确保测试更加针对性且接近真实应用场景。

示例配置：

system-prompts: |
  You are a chatbot.
  Your job is to answer questions about meditation.
  Now we are ready to go.

使用指导：

• 修改system-prompts.yaml以匹配您的ChatGPT实例环境。
• 执行python3 promptmap.py来开始安全测试，默认情况下会对每个类别生成并测试5次攻击性prompt。
• 可以通过命令行参数如-n 10来增加测试次数，或使用-o prompts.json -n 10保存成功攻击的prompt至JSON文件中，便于后续分析。

此文档提供了基本的指引以帮助您理解并开始使用promptmap工具，确保ChatGPT实例的安全性得到加强和验证。