大模型快速入门必备使用OpenAI API进行开发（环境配置）

引言：

欢迎进入OpenAI API的世界！如果你是一名开发者，希望利用OpenAI最先进的模型为你的应用程序添加智能层，那么你来对地方了。博客将帮助你快速搭建本地开发环境，并发送你的第一个API请求。我们的API参考和GPT指南都是极佳的起点。在本快速入门指南中，你将学到：

• 如何设置你的开发环境
• 如何安装最新的SDK
• OpenAI API的基本概念
• 如何发送你的第一个API请求

账户设置

首先，创建或登录你的OpenAI账户。接着，导航至API密钥页面并“创建新的密钥”，可选择命名你的密钥。请确保将其安全保存，并不与他人共享。

快速入门语言选择

选择你想使用的工具或语言以开始使用OpenAI API。

Python是一种广泛用于数据应用、网络开发及许多其他编程任务的流行编程语言。OpenAI提供了一个Python库，使得在Python中使用OpenAI API变得简单高效。

第一步：安装Python以及虚拟环境

安装Python 要使用OpenAI的Python库，你需要确保已经安装了Python。有些计算机预装了Python，而其他的则需要你自己设置。要测试是否安装了Python，可以在终端或命令行中输入python并回车。如果你进入了Python解释器，那么你的计算机已经安装了Python，可以进行下一步。如果出现类似“错误：未找到命令python”的错误消息，你可能需要安装Python并使其在终端/命令行中可用。

下载Python，请前往Python官网并下载最新版本。要使用OpenAI的Python库，你需要至少Python 3.7.1或更新版本。如果你是首次安装Python，可以遵循Python官方的安装指南。

设置虚拟环境（可选） 一旦安装了Python，建议创建一个虚拟Python环境来安装OpenAI Python库。虚拟环境为你的Python包提供了一个干净的工作空间，这样你就不会与其他项目中安装的库发生冲突。如果你不想设置虚拟环境，可以跳过这一步。

使用Python内置的venv模块，运行以下命令在当前文件夹内创建名为"openai-env"的虚拟环境：

python -m venv openai-env

创建虚拟环境后，你需要激活它。在Windows上，运行：

openai-env\Scripts\activate

在Unix或MacOS上，运行：

source openai-env/bin/activate

激活虚拟环境后，你应该会看到终端/命令行界面略有变化，现在在光标输入部分的左侧应该显示“openai-env”。有关虚拟环境的更多细节，请参阅官方Python文档。

安装OpenAI Python库

一旦安装了Python 3.7.1或更高版本，并且（可选地）设置了虚拟环境，就可以安装OpenAI Python库了。在终端/命令行中运行：

pip install --upgrade openai

完成后，运行pip list将显示你在当前环境中安装的Python库，这应该可以确认OpenAI Python库已经成功安装。

第2步：设置你的API密钥

为所有项目设置API密钥（推荐）

让你的API密钥对所有项目可访问的主要优势是，Python库将自动检测并使用它，无需编写任何代码。

MacOS

1. 打开终端：你可以在应用程序文件夹中找到它，或使用Spotlight搜索（Command + Space）。

2. 编辑Bash配置文件：使用命令nano ~/.bash_profile 或 nano ~/.zshrc（对于较新的MacOS版本）在文本编辑器中打开配置文件。

3. 添加环境变量：在编辑器中，添加以下行，将your-api-key-here替换为你的实际API密钥：

export OPENAI_API_KEY='your-api-key-here'

1. 保存并退出：按Ctrl+O写入更改，然后按Ctrl+X关闭编辑器。

2. 加载你的配置文件：使用命令source ~/.bash_profile 或 source ~/.zshrc加载更新后的配置文件。

3. 验证：通过在终端中键入echo $OPENAI_API_KEY来验证设置。它应该显示你的API密钥。

Windows

1. 打开命令提示符：你可以通过在开始菜单中搜索“cmd”来找到它。

2. 在当前会话中设置环境变量：要在当前会话中设置环境变量，请使用以下命令，将your-api-key-here替换为你的实际API密钥：

setx OPENAI_API_KEY "your-api-key-here"

1. 此命令将为当前会话设置OPENAI_API_KEY环境变量。

2. 永久设置：要使设置永久化，请通过系统属性添加变量，操作如下：

   • 右键点击“此电脑”或“我的电脑”，选择“属性”。
   • 点击“高级系统设置”。
   • 点击“环境变量”按钮。
   • 在“系统变量”部分，点击“新建...”，输入OPENAI_API_KEY作为变量名，你的API密钥作为变量值。

3. 验证：重新打开命令提示符并输入以下命令来验证设置。它应该显示你的API密钥：echo %OPENAI_API_KEY%

为单个项目设置API密钥

如果你只希望你的API密钥可供单个项目访问，你可以在项目文件夹中创建一个包含API密钥的本地.env文件，然后在后续步骤中的Python代码中明确使用该API密钥。

首先，前往你想要创建.env文件的项目文件夹。

为了使你的.env文件被版本控制忽略，可以在项目目录的根部创建一个.gitignore文件。在其中添加一行.env，这样就可以确保你的API密钥或其他机密不会通过版本控制意外共享。

在终端或集成开发环境（IDE）中创建.gitignore和.env文件后，将你的秘密API密钥复制并设置为你的.env文件中的OPENAI_API_KEY。如果你还没有创建密钥，可以在API密钥页面上进行。

.env文件应如下所示：

# 添加你的API密钥后，请确保不与任何人共享！API密钥应保持私密。
OPENAI_API_KEY=abc123

通过运行以下代码可以导入API密钥：

from openai import OpenAI

client = OpenAI()
# 默认使用os.environ.get("OPENAI_API_KEY")获取密钥
# 如果你在不同的环境变量名称下保存了密钥，你可以这样做：
# client = OpenAI(
#   api_key=os.environ.get("CUSTOM_ENV_NAME"),
# )

第3步：发送你的第一个API请求

发起API请求

在配置好Python并设置好API密钥之后，最后一步是使用Python库向OpenAI API发送请求。为此，请使用终端或集成开发环境（IDE）创建一个名为openai-test.py的文件。

在文件中，复制并粘贴以下示例之一：

聊天完成

from openai import OpenAI
client = OpenAI()

completion = client.chat.completions.create(
  model="gpt-3.5-turbo",
  messages=[
    {"role": "system", "content": "你是一个诗意的助手，擅长用创造性的方式解释复杂的编程概念。"},
    {"role": "user", "content": "编写一首诗，解释编程中的递归概念。"}
  ]
)

print(completion.choices[0].message)

要运行代码，在终端/命令行中输入python openai-test.py。

聊天完成示例只是我们模型强大功能的一个展示：创造力。用格式良好的诗歌解释递归（编程主题）是最优秀的开发者和诗人都会觉得有难度的任务。在这种情况下，gpt-3.5-turbo却能轻松完成。

总结

这篇博客是一份关于如何使用OpenAI API的详细指南，旨在帮助开发者快速入门并实践。它首先介绍了如何创建OpenAI账户和获取API密钥，然后详细说明了在不同操作系统（如MacOS和Windows）中设置环境变量以全局或项目级别使用API密钥的步骤。接着，博客概述如何安装OpenAI的Python库并创建虚拟环境。最后，提供了一个实例，展示了如何使用Python编写并运行代码，向OpenAI API发送第一个请求，特别是通过Chat Completions功能，使用模型gpt-3.5-turbo生成创造性内容。