在openai-agents-python项目中使用Azure OpenAI API的实践指南

前言

随着大语言模型(LLM)技术的快速发展，越来越多的开发者希望将不同云服务提供商的LLM集成到自己的应用中。openai-agents-python作为一个功能强大的代理框架，提供了灵活的接口来支持多种LLM服务提供商。本文将详细介绍如何在openai-agents-python项目中使用Azure OpenAI API。

基本集成方法

在openai-agents-python中集成Azure OpenAI API主要有两种方式：

1. 直接设置默认客户端：这是最简单直接的方法，通过设置默认的异步Azure OpenAI客户端来实现。

from openai import AsyncAzureOpenAI
from agents import set_default_openai_client, set_tracing_disabled

# 初始化Azure OpenAI客户端
azure_client = AsyncAzureOpenAI(
    api_key="你的API密钥",
    api_version="2024-06-01",  # 使用最新API版本
    azure_endpoint="你的Azure终结点URL",
    azure_deployment="你的部署名称"
)

# 设置为默认客户端
set_default_openai_client(azure_client)

# 禁用追踪功能，因为Azure不支持
set_tracing_disabled(True)

2. 通过模型参数指定：在创建Agent时直接指定自定义的OpenAI客户端。

from openai import AsyncAzureOpenAI
from agents import Agent, OpenAIChatCompletionsModel

azure_client = AsyncAzureOpenAI(...)

agent = Agent(
    name="中文代理",
    instructions="你只能说中文。",
    model=OpenAIChatCompletionsModel(
        model="你的部署名称",
        openai_client=azure_client,
    ),
    model_settings=ModelSettings(temperature=0.5),
)

实际应用示例

下面是一个完整的示例，展示如何创建一个使用Azure OpenAI服务的Agent并执行简单任务：

from openai import AsyncAzureOpenAI
from agents import Agent, OpenAIChatCompletionsModel, ModelSettings, Runner

# 初始化Azure客户端
azure_client = AsyncAzureOpenAI(
    api_key="你的API密钥",
    api_version="2024-06-01",
    azure_endpoint="https://your-resource.openai.azure.com",
    azure_deployment="gpt-4-deployment"
)

# 创建中文代理
agent = Agent(
    name="中文诗人",
    instructions="你是一位精通中国古典诗歌的AI助手。",
    model=OpenAIChatCompletionsModel(
        model="gpt-4-deployment",
        openai_client=azure_client,
    ),
    model_settings=ModelSettings(temperature=0.7),
)

# 运行代理
result = Runner.run_sync(agent, "请写一首关于春天的七言绝句。")
print(result)

常见问题与解决方案

1. API密钥错误：当使用自定义客户端时，仍需设置OPENAI_API_KEY环境变量，即使值为空。

# 在终端中执行
export OPENAI_API_KEY=""

2. 追踪功能冲突：Azure OpenAI服务不支持追踪功能，必须显式禁用：

set_tracing_disabled(True)

3. 模型名称不匹配：在Azure中部署的模型可能有自定义名称，确保在代码中使用的是部署名称而非原始模型名称。

扩展应用：支持其他云服务商

同样的方法也适用于其他兼容OpenAI API的云服务提供商，如阿里云的Qwen模型：

from openai import AsyncOpenAI

external_client = AsyncOpenAI(
    api_key="你的API密钥",
    base_url="服务商提供的兼容模式终结点",
)

agent = Agent(
    name="多模型代理",
    instructions="你是一个多模型支持助手。",
    model=OpenAIChatCompletionsModel(
        model="服务商指定的模型名称",
        openai_client=external_client,
    ),
)

性能优化建议

1. 连接池管理：对于高并发场景，考虑自定义HTTP客户端以优化连接池设置。

2. 超时配置：根据网络状况调整超时参数，避免长时间等待。

3. 重试策略：配置适当的重试策略以应对临时性故障。

结语

通过openai-agents-python框架，开发者可以灵活地将Azure OpenAI或其他兼容OpenAI API的服务集成到自己的应用中。本文介绍的方法不仅适用于Azure，也可扩展到其他云服务提供商。掌握这些技巧后，开发者可以根据实际需求选择最适合的LLM服务，构建更加强大和灵活的AI应用。