openai-python

环境要求

• Python 3.10 或更高版本
• 可用 pip 包管理器的 Python 环境
• 一个可用的 OPENAI_API_KEY（从平台后台获取）

安装与启动步骤

1. 1确认 Python 版本

   README 要求 Python 3.10+，先确认本机解释器版本，低于 3.10 需先升级

   python3 --version

   复制

2. 2安装 SDK

   从 PyPI 安装官方包，全程只有一条命令，无需拉取源码编译

   pip install openai

   复制

3. 3设置 API Key

   把密钥放到环境变量，避免写死在源码里被提交到版本库

   export OPENAI_API_KEY="sk-xxxxxxxx"

   复制

4. 4编写调用脚本

   新建 quickstart.py，用 OpenAI 客户端调用 Responses API 并打印文本结果

   cat > quickstart.py <<'EOF'
   import os
   from openai import OpenAI
   
   client = OpenAI(
       api_key=os.environ.get("OPENAI_API_KEY"),
   )
   
   response = client.responses.create(
       model="gpt-5.5",
       instructions="You are a coding assistant that talks like a pirate.",
       input="How do I check if a Python object is an instance of a class?",
   )
   
   print(response.output_text)
   EOF

   复制

5. 5运行脚本

   执行脚本，正常时会直接打印模型返回的文本内容

   python3 quickstart.py

   复制

6. 6核对已安装版本

   若升级后功能没变化，多半是环境仍用旧版本，用该命令确认运行时版本

   python3 -c "import openai; print(openai.__version__)"

   复制

关键配置

如何确认成功

运行脚本后终端打印出模型生成的文本，且 openai.__version__ 能输出版本号，即安装与调用都正常。

常见问题

注意事项

• 项目要求 Python 3.10 及以上，版本过低会在导入或运行时出错。
• API Key 只放环境变量或 .env 文件，不要提交到 Git 仓库。
• 同步与异步客户端功能一致，按业务场景选择，异步代码记得加 await。
• 接口与类型定义随官方规范生成，升级后建议复查调用的参数名。