ShellGPT项目配置Azure API的完整指南

在使用ShellGPT对接Azure OpenAI服务时，许多开发者遇到了配置难题。本文将详细介绍正确的配置方法，帮助开发者快速完成服务接入。

核心配置要点

ShellGPT通过LiteLLM中间件支持Azure OpenAI服务，需要特别注意以下配置项：

1. 必须启用LiteLLM模式 在.sgptrc配置文件中必须明确设置：

   USE_LITELLM=true
   

2. API密钥的特殊要求 即使使用Azure服务，仍然需要设置OPENAI_API_KEY参数：

   OPENAI_API_KEY=<你的Azure密钥>
   

   这是ShellGPT的强制要求，否则会直接报错。

环境变量配置

除了配置文件外，还需要设置以下环境变量：

export AZURE_API_BASE=https://你的服务端点.api.cognitive.microsoft.com/
export OPENAI_API_VERSION=2024-02-01

注意这些变量必须通过环境变量设置，放在.sgptrc文件中不会生效。

常见问题解决

1. APIKey缺失错误 如果遇到要求提供OPENAI_API_KEY的情况，请检查：

   • USE_LITELLM是否设置为true
   • OPENAI_API_KEY是否已配置

2. NoneType错误 出现"argument of type 'NoneType' is not iterable"错误时：

   • 确认AZURE_API_BASE和OPENAI_API_VERSION已正确导出为环境变量
   • 确保没有在.sgptrc中设置这些变量

3. 版本兼容性 推荐使用Python 3.12.2和shell-gpt 1.4.0版本组合，其他版本可能存在兼容性问题。

最佳实践建议

1. 将USE_LITELLM和OPENAI_API_KEY统一放在.sgptrc文件中管理
2. Azure相关参数通过环境变量设置
3. 测试时可以先验证LiteLLM直接调用是否正常，再排查ShellGPT配置问题

通过以上配置，开发者可以顺利将ShellGPT与Azure OpenAI服务集成，享受强大的AI命令行体验。