OpenAI API Python调用教程

OpenAI API Python调用完整指南

OpenAI API 为开发者提供了强大的人工智能能力，通过 Python 调用 OpenAI API 可以轻松实现文本生成、对话系统、代码补全等功能。本教程将详细介绍如何使用 Python 调用 OpenAI API，从环境配置到实际应用，帮助你快速上手。

准备工作：获取 API 密钥

在开始使用 OpenAI API Python调用之前，你需要先获取 API 密钥。访问 OpenAI 官网注册账号，在账户设置中创建新的 API Key。请妥善保管你的密钥，不要将其提交到公开的代码仓库中。

安装必要的 Python 库

首先需要安装 OpenAI 官方提供的 Python 客户端库。打开终端或命令提示符，执行以下命令：

pip install openai

如果你使用的是较新版本的 Python（3.7+），建议同时安装 python-dotenv 来管理环境变量：

pip install python-dotenv

基础配置：设置 API 密钥

为了安全起见，建议将 API 密钥存储在环境变量中。创建一个 .env 文件：

OPENAI_API_KEY=your_api_key_here

然后在 Python 代码中加载：

import os
from dotenv import load_dotenv
from openai import OpenAI

# 加载环境变量
load_dotenv()

# 初始化客户端
client = OpenAI(
    api_key=os.getenv("OPENAI_API_KEY")
)

第一个 OpenAI API Python调用示例

让我们从最简单的文本生成开始。以下是一个完整的示例代码：

from openai import OpenAI
import os

client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))

# 调用 Chat Completions API
response = client.chat.completions.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "你是一个有帮助的助手。"},
        {"role": "user", "content": "请用一句话介绍 Python 编程语言。"}
    ],
    temperature=0.7,
    max_tokens=150
)

# 输出结果
print(response.choices[0].message.content)

参数详解

• model: 指定使用的模型，如 gpt-3.5-turbo、gpt-4 等
• messages: 对话历史数组，包含 system、user、assistant 三种角色
• temperature: 控制输出的随机性，范围 0-2，值越高越随机
• max_tokens: 限制生成的最大 token 数量

进阶应用：流式输出

对于长文本生成，流式输出可以提供更好的用户体验。通过设置 stream=True 参数实现：

response = client.chat.completions.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "user", "content": "写一篇关于人工智能的短文"}
    ],
    stream=True
)

for chunk in response:
    if chunk.choices[0].delta.content is not None:
        print(chunk.choices[0].delta.content, end="")

实用技巧：错误处理与重试机制

在实际应用中，网络问题或 API 限流可能导致请求失败。建议添加错误处理和重试逻辑：

import time
from openai import OpenAI, OpenAIError

def call_openai_with_retry(client, messages, max_retries=3):
    for attempt in range(max_retries):
        try:
            response = client.chat.completions.create(
                model="gpt-3.5-turbo",
                messages=messages
            )
            return response.choices[0].message.content
        except OpenAIError as e:
            if attempt < max_retries - 1:
                wait_time = 2 ** attempt  # 指数退避
                print(f"请求失败，{wait_time}秒后重试...")
                time.sleep(wait_time)
            else:
                raise e

多轮对话实现

构建对话系统时，需要维护对话历史。以下是一个简单的对话循环示例：

messages = [
    {"role": "system", "content": "你是一个友好的助手。"}
]

while True:
    user_input = input("你: ")
    if user_input.lower() in ['退出', 'quit', 'exit']:
        break
    
    messages.append({"role": "user", "content": user_input})
    
    response = client.chat.completions.create(
        model="gpt-3.5-turbo",
        messages=messages
    )
    
    assistant_message = response.choices[0].message.content
    messages.append({"role": "assistant", "content": assistant_message})
    
    print(f"助手: {assistant_message}")

成本优化建议

使用 OpenAI API Python调用时，合理控制成本很重要：

• 根据需求选择合适的模型，gpt-3.5-turbo 比 gpt-4 便宜很多
• 设置合理的 max_tokens 限制，避免不必要的长输出
• 对于简单任务，可以使用更低的 temperature 值减少重试次数
• 实现缓存机制，避免重复请求相同内容
• 考虑使用 API 中转服务来降低调用成本，特别是对于高频应用场景

Function Calling 功能

OpenAI API 支持函数调用功能，让模型能够调用外部工具。这是构建智能助手的关键能力：

tools = [
    {
        "type": "function",
        "function": {
            "name": "get_weather",
            "description": "获取指定城市的天气信息",
            "parameters": {
                "type": "object",
                "properties": {
                    "city": {
                        "type": "string",
                        "description": "城市名称"
                    }
                },
                "required": ["city"]
            }
        }
    }
]

response = client.chat.completions.create(
    model="gpt-3.5-turbo",
    messages=[{"role": "user", "content": "北京今天天气怎么样？"}],
    tools=tools,
    tool_choice="auto"
)

# 检查是否需要调用函数
if response.choices[0].message.tool_calls:
    tool_call = response.choices[0].message.tool_calls[0]
    function_name = tool_call.function.name
    arguments = tool_call.function.arguments
    print(f"模型想调用函数: {function_name}")
    print(f"参数: {arguments}")

常见问题解答

总结

通过本教程，你已经掌握了 OpenAI API Python调用的核心技能，从基础配置到进阶应用都有涉及。无论是构建聊天机器人、内容生成工具还是智能助手，这些知识都能帮助你快速实现想法。记住要合理控制成本、处理好错误情况，并始终关注数据安全。随着实践经验的积累，你会发现更多创新的应用场景。