在openai-python库中配置Azure API Manager代理访问Azure OpenAI服务

在实际企业级应用中，出于安全、监控和流量管理等需求，通常会通过API管理服务(如Azure API Manager)来代理访问云服务。本文将详细介绍如何在openai-python库中配置使用Azure API Manager作为代理来访问Azure OpenAI服务。

背景与需求

当企业使用Azure OpenAI服务时，常见的架构设计是通过Azure API Manager(APIM)进行代理访问。这种架构带来了几个优势：

1. 集中管理API访问权限和密钥
2. 实现请求监控和日志记录
3. 进行流量控制和限流
4. 提供额外的安全层

在这种架构下，客户端不再直接访问Azure OpenAI的终端节点，而是通过APIM的自定义端点进行访问，同时使用APIM的订阅密钥而非原始的API密钥。

解决方案实现

openai-python库的AzureOpenAI客户端提供了灵活的配置选项来支持这种代理场景。关键配置参数包括：

1. base_url - 指定APIM的自定义终端节点
2. default_headers - 设置APIM要求的认证头信息
3. api_version - 指定使用的API版本

以下是完整的配置示例代码：

from openai import AzureOpenAI

# 初始化客户端
client = AzureOpenAI(
    base_url="https://your-apim-instance.azure-api.net/deployments/modelName",
    api_key="placeholder",  # 这里可以填写任意值，因为实际认证使用header
    default_headers={
        "Ocp-Apim-Subscription-Key": "your_apim_subscription_key"
    },
    api_version="2024-02-01"  # 使用最新的稳定API版本
)

# 使用客户端进行聊天补全
response = client.chat.completions.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "你是一个有帮助的AI助手"},
        {"role": "user", "content": "Azure机器学习与Azure AI服务有什么区别？"}
    ]
)

关键配置说明

1. base_url参数：

   • 格式为APIM实例的HTTPS端点加上部署路径
   • 通常包含APIM实例名称和模型部署名称

2. 认证头信息：

   • Azure API Manager通常使用"Ocp-Apim-Subscription-Key"作为认证头
   • 该值通过default_headers参数设置

3. API版本：

   • 建议使用最新的稳定版本
   • 不同版本可能有功能差异

最佳实践建议

1. 将敏感信息如订阅密钥存储在安全的位置(如Azure Key Vault)，而非硬编码在代码中
2. 为不同环境(开发、测试、生产)配置不同的APIM实例
3. 在APIM中设置适当的速率限制和配额策略
4. 启用详细的请求日志记录用于审计和故障排除

通过这种配置方式，企业可以在保持原有应用逻辑不变的情况下，轻松集成API管理层的各种高级功能，同时继续使用openai-python库的所有功能。