PyRIT项目中AI兼容性接口的API版本参数问题解析

在Azure开源的PyRIT项目中，开发人员发现了一个关于AI兼容性接口的重要技术问题。这个问题涉及到当使用AITarget及其变体与非AI提供商（如Google Gemini）交互时，系统会自动添加api-version查询参数，导致API调用失败。

问题背景

PyRIT项目中的AI目标类（AITarget及其子类）设计用于与各种AI模型服务交互。这些类默认包含一个api_version属性，其默认值为特定日期格式（如"2024-06-01"）。这个参数会被自动附加到所有API请求的URL中作为查询参数。

问题表现

当开发者尝试使用这些目标类与Google Generative Language API（Gemini）交互时，系统会在请求URL中自动添加api-version参数。例如：

https://generativelanguage.googleapis.com/v1beta/ai?api-version=2024-06-01

这会导致404错误，因为Gemini API并不支持这个参数。更严重的是，即使显式设置api_version=None，系统仍会添加一个空的api-version参数，同样会导致请求失败。

技术分析

这个问题源于PyRIT项目中多个AI相关目标类的实现方式：

1. AIChatTarget
2. AICompletionTarget
3. RealtimeTarget
4. AIDALLETarget
5. AITTSTarget

这些类在构造API请求时都会无条件地添加api-version参数，而没有考虑目标API是否支持这个参数。

解决方案

针对这个问题，社区提出了以下解决方案：

1. 修改api_version参数的处理逻辑，当设置为None时，不添加该查询参数
2. 保持现有默认值，以确保向后兼容性

具体实现可以采用如下方式：

params = {"api-version": self._api_version} if self._api_version is not None else {}

影响范围

这个问题主要影响以下使用场景：

1. 使用PyRIT的AI目标类与非AI提供商交互
2. 特别是使用Google Gemini API时
3. 任何不支持api-version查询参数的兼容性API

最佳实践建议

对于开发者使用PyRIT与第三方AI服务交互时，建议：

1. 检查目标API是否支持api-version参数
2. 如果不支持，确保将api_version显式设置为None
3. 对于Gemini API，还需要注意在endpoint中添加"/chat/completions"路径

这个问题展示了在构建通用AI接口时需要考虑不同提供商API差异的重要性，也为PyRIT项目的兼容性改进提供了宝贵经验。