compliant-llm 的安装和配置教程

1. 项目的基础介绍和主要的编程语言

compliant-llm 是一个用于确保人工智能系统遵守性、可靠性和安全性的全面工具包。它可以跨多个合规框架（如 NIST、ISO、HIPAA、GDPR 等）工作。该项目由信息安全管理团队、合规团队和人工智能工程师使用，以确保 AI 系统经过良好的测试，并符合任何组织的合规政策和控制。compliant-llm 支持多个大型语言模型（LLM）提供者，并可用于测试提示、代理、MCP 服务器和生成 AI 模型。该项目主要使用 Python 编程语言。

2. 项目使用的关键技术和框架

该项目使用了以下关键技术和框架：

• 测试策略：包括对抗性攻击策略测试，例如提示注入、越狱尝试、过度的代理性、间接提示注入、不安全的输出处理、模型拒绝服务攻击、模型提取攻击和信息泄露攻击等。
• 可视化仪表板：用于分析测试结果。
• 端到端测试：测试 AI 系统的完整流程。
• 详细报告：生成包含可操作见解的全面报告。
• 支持多种 LLM 提供者：通过 LiteLLM 与不同的 LLM 提供者配合工作。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装之前，请确保您的系统中已安装以下依赖项：

• Python 3.6 或更高版本
• pip 包管理器

安装步骤

1. 安装 compliant-llm

   通过 pip 命令安装 compliant-llm：

   pip install compliant-llm
   

2. 配置 API 密钥

   在项目目录中创建一个 .env 文件，并输入您的 LLM 提供商 API 密钥。例如：

   touch .env
   

   然后在 .env 文件中写入以下内容：

   OPENAI_API_KEY=your-openai-api-key-here
   ANTHROPIC_API_KEY=your-anthropic-api-key-here
   GOOGLE_API_KEY=your-google-api-key-here
   

   替换 your-openai-api-key-here、your-anthropic-api-key-here 和 your-google-api-key-here 为您实际的 API 密钥。

3. 运行基本的红队测试

   通过命令行运行一个基本的红队测试：

   compliant-llm test --prompt "You are a helpful assistant who can only respond ethically" --strategy "prompt_injection,jailbreak"
   

4. 启动 UI

   如果您想从用户界面开始，可以运行以下命令：

   compliant-llm dashboard
   

5. 使用配置文件

   或者，您可以使用配置文件运行测试：

   compliant-llm test --config_path configs/config.yaml
   

   请确保您有一个有效的配置文件在 configs/config.yaml 路径下。

所有测试报告将自动保存在项目目录中的 reports/ 文件夹内，该文件夹已被排除在版本控制之外。

完成以上步骤后，您就可以开始使用 compliant-llm 进行 AI 系统的合规性和安全性测试了。