SWE-agent项目中使用Azure OpenAI API密钥的配置指南

背景介绍

SWE-agent是一个基于自然语言处理的软件开发辅助工具，它可以通过与用户的自然语言交互来帮助完成编程任务。该项目支持多种AI模型后端，包括OpenAI官方API和Azure OpenAI服务。

关键配置问题

在使用Azure OpenAI服务时，开发者需要特别注意配置文件的正确设置。常见的配置错误包括：

1. 环境变量命名不规范
2. 部署名称与实际不符
3. API版本不匹配

正确配置方法

配置文件设置

在keys.cfg文件中，需要包含以下关键配置项：

AZURE_OPENAI_API_KEY: '你的Azure OpenAI API密钥'
AZURE_OPENAI_ENDPOINT: '你的Azure OpenAI终结点URL'
AZURE_OPENAI_DEPLOYMENT: '你的部署名称(如gpt-4)'
AZURE_OPENAI_API_VERSION: 'API版本号(如2024-05-01-preview)'

启动参数

运行SWE-agent时，必须明确指定使用Azure模型：

./start_web_ui.sh --model azure:gpt4

技术细节解析

1. 模型部署名称：AZURE_OPENAI_DEPLOYMENT应与你实际在Azure门户中创建的部署名称完全一致，区分大小写。

2. API版本：不同版本的API可能有不同的功能和参数要求，确保使用支持的版本。

3. 端点URL：格式通常为https://[your-resource-name].openai.azure.com/。

常见问题排查

1. 密钥未找到错误：检查配置文件是否放在正确位置，变量名是否拼写正确。

2. 模型不可用：确认部署名称是否正确，以及该部署是否已成功完成。

3. API版本不兼容：查看Azure文档获取最新的支持版本号。

最佳实践建议

1. 使用环境变量管理敏感信息，而非直接写在配置文件中。

2. 为不同环境(开发/测试/生产)维护不同的配置文件。

3. 定期检查并更新API版本，以获取最新功能和性能优化。

通过正确配置这些参数，开发者可以充分利用Azure OpenAI的强大能力，同时保持与SWE-agent的无缝集成。