OpenAI CTO

开发人员快速启动

本快速入门旨在帮助您设置本地开发环境并发送第一个 API 请求。如果您是一名经验丰富的开发者或想直接了解如何使用 OpenAI API，可以参考 API 参考 或 文本生成指南。在本快速入门中，您将了解：

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

如果您在开始使用时遇到问题或有疑问，请加入我们的 开发者论坛。

账户设置

首先，创建一个 OpenAI 账户 或 登录。然后，导航到 API 密钥页面 并点击“创建新的密钥”，可选择为密钥命名。务必将其保存在安全的地方，并且不要与他人分享。

快速入门语言选择

选择您想要使用 OpenAI API 的工具或编程语言。

Python 是一种流行的编程语言，常用于数据应用、Web 开发和许多其他编程任务，因为它易于使用。OpenAI 提供了一个自定义的 Python 库，使在 Python 中使用 OpenAI API 变得简单且高效。

第1步： 设置Python

安装 Python

要使用 OpenAI Python 库，您需要确保已在电脑上安装了 Python。一些电脑预先安装了 Python，而其他电脑则需要您自己进行安装。要检查是否已安装 Python，可以打开终端或命令行：

  • MacOS：打开“终端”，可以在“应用程序”文件夹中找到它，或者使用 Spotlight（Command + Space）进行搜索。
  • Windows：打开“命令提示符”，可以在启动菜单中进行搜索。

然后，输入单词 python，按回车/Enter 键。如果进入了 Python 解释器，则表示已在电脑上安装了 Python，可以进行下一步。如果出现类似于“Error: command python not found”的错误消息，则可能需要安装 Python 并将其添加到终端/命令行中。

要下载 Python，请访问 官方 Python 网站 并下载最新版本。要使用 OpenAI Python 库，您至少需要 Python 3.7.1 或更新版本。如果您是第一次安装 Python，可以遵循 官方 Python 安装指南 进行操作。

设置虚拟环境 （可选）

一旦安装了 Python，最好的做法是创建一个虚拟 Python 环境来安装 OpenAI Python 库。虚拟环境为您的 Python 包提供了一个干净的工作空间，以便您不会与为其他项目安装的库发生冲突。您不必使用虚拟环境，因此可以跳到第 3 步。

要创建虚拟环境，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. 打开命令提示符：可以在启动菜单中进行搜索。
  2. 在当前会话中设置环境变量：要在当前会话中设置环境变量，请使用以下命令，将 your-api-key-here 替换为实际的 API 密钥：
setx OPENAI_API_KEY "your-api-key-here"

此命令将设置 OPENAI_API_KEY 环境变量，用于当前会话。 3. 永久性设置：要使设置永久性，请通过系统属性按照以下步骤操作：

  • 右键单击“此电脑”或“我的电脑”，然后选择“属性”。
  • 单击“高级系统设置”。
  • 单击“环境变量”按钮。
  • 在“系统变量”部分中，单击“新建...”，然后将 OPENAI_API_KEY 作为变量名，将 API 密钥作为变量值。
  1. 验证：要验证设置，请重新打开命令提示符并键入以下命令。它应该显示您的 API 密钥：
echo %OPENAI_API_KEY%

为单个项目设置API密钥

如果您想要将 API 密钥仅限于单个项目，可以创建一个本地 .env 文件，其中包含 API 密钥，然后在将来的 Python 代码中显式使用该 API 密钥。

首先，转到您想要在其中创建 .env 文件的项目文件夹。

在 order for your .env file to be ignored by version control, create a .gitignore file in the root of your project directory. Add a line with .env on it which will make sure your API key or other secrets are not accidentally shared via version control.

一旦创建了 .gitignore 和 .env 文件，请复制您的 API 密钥并将其设置为 .env 文件中的 OPENAI_API_KEY。如果您还没有创建 API 密钥，可以在 API 密钥页面 进行创建。

.env 文件应该如下所示：

# Once you add your API key below, make sure to not share it with anyone! The API key should remain private.

OPENAI_API_KEY=abc123

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

from openai import OpenAI

client = OpenAI()
# defaults to getting the key using os.environ.get("OPENAI_API_KEY")

# if you saved the key under a different environment variable name, you can do something like:
# client = OpenAI(
#   api_key=os.environ.get("CUSTOM_ENV_NAME"),
# )

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

发送API请求

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

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

from openai import OpenAI

client = OpenAI()

completion = client.chat.completions.create(
  model="gpt-3.5-turbo",
  messages=[
    {"role": "system", "content": "You are a poetic assistant, skilled in explaining complex programming concepts with creative flair."},
    {"role": "user", "content": "Compose a poem that explains the concept of recursion in programming."}
  ]
)

print(completion.choices[0].message)

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

Chat Completions 示例突出了我们的模型在创造性方面的实力。解释递归（编程主题）的同时撰写一首格调良好的诗是最好的开发者和最好的诗人都会感到困难的事情。在这种情况下，gpt-3.5-turbo 却轻而易举地完成了。

下一步

现在，您已经成功地向 OpenAI API 发送了第一个请求，接下来可以探索其他可能性：

  • 要了解更多关于我们的模型和 API 的信息，请参考我们的 文本生成指南。
  • 访问 OpenAI 烹饪书，了解详细的 API 使用案例和常见任务的代码片段。
  • 想要了解 OpenAI 的模型能够做什么？查看我们的 示例提示词库。
  • 想要在不编写任何代码的情况下尝试 API？在 Playground 中开始探索。
  • 使用时请遵循我们的 使用策略。

Was this page helpful?