giskard-oss

环境要求

• Python 3.12 或更高版本
• pip 包管理工具（用于 pip install）
• 使用 LLM judge / 扫描生成器时，需准备对应 provider 的 API Key（如 openai extra）
• （可选）可访问 PyPI 的网络环境

安装与启动步骤

1. 1检查 Python 版本

   Giskard 要求 Python 3.12+，先确认本机版本满足要求，否则先升级 Python 再安装。

   python --version

   复制

2. 2安装 giskard 核心

   安装基础包，包含 giskard-checks 及其依赖（agents、llm、core），用于测试与评估。

   pip install giskard

   复制

3. 3安装扫描扩展

   需要漏洞扫描或 RAG/质量评估时，安装 scan extra 以获取 giskard-scan 模块。

   pip install "giskard[scan]"

   复制

4. 4安装 provider 扩展

   LLM judge 与扫描生成器需要 provider SDK，例如安装 openai extra；其他 provider 见 pyproject.toml 可选依赖。

   pip install "giskard[openai]"

   复制

5. 5可选关闭遥测

   如不希望发送聚合分析数据，可在导入前设置环境变量；也可写入工作目录的 .env 文件。

   export DO_NOT_TRACK=1

   复制

6. 6运行 Checks 示例

   把 README 的 Quickstart 代码保存为 quickstart.py，替换 get_answer 为自己的模型或智能体调用后运行。

   python quickstart.py

   复制

7. 7运行漏洞扫描示例

   把扫描 Quickstart 保存为 scan_demo.py，target 替换为自己的异步 agent 函数，description 填被测应用描述。

   python scan_demo.py

   复制

关键配置

如何确认成功

运行两个 Quickstart 脚本后终端无异常，并打印出场景测试报告（result.print_report() 输出），即表示安装与调用成功。

常见问题

注意事项

• 遥测为可选聚合分析，不会发送 prompt 或输出内容。
• provider extra 除 openai 外还有 anthropic 等，具体名称以项目 pyproject.toml 的可选依赖为准。
• v3 是重写版本，去掉了重型依赖，包按需引入，不要一次性安装全部 extra。
• 完整用法见官方文档 https://docs.giskard.ai/oss（Suites、LLMJudge、多轮场景等）。