发布于 2026-01-06 3 阅读
0

如何将 OpenAI API 密钥设置为环境变量?

如何将 OpenAI API 密钥设置为环境变量?

OpenAI API 密钥与其他 API 密钥类似。它们是授予对特定服务或资源访问权限的唯一标识符。OpenAI 的 API 密钥使用户能够使用 OpenAI 的 API。它们使开发者能够访问强大的语言模型和工具,用于自然语言处理任务。

OpenAI 网站

作为开发者,我们都希望尽可能简化开发流程。许多开发者都乐于掌握的一个方法是将 API 密钥设置为环境变量。这为开发者提供了一种灵活且安全的方式,可以将配置设置存储在工作代码之外,从而使其更易于管理和长期复用。

请注意,实现 API 密钥需要 API 开发平台或工具。如果您还没有合适的平台或工具,强烈建议您尝试使用 Apidog。就我个人而言,我发现Apidog包含了 API 生命周期所需的所有工具,因此我不需要其他应用程序来进行 API 开发。

您应该将 OpenAI API 密钥设置为环境变量的原因有以下几点:您可以:

集中配置:将 API 密钥存储在一个位置,便于管理和更新。

提高安全性:防止将 API 密钥直接硬编码到应用程序代码中,降低意外泄露的风险。

简化部署:无需修改代码即可轻松将应用程序部署到不同的环境(例如,开发、生产)。

增强灵活性:无需重新部署应用程序即可轻松更改 API 密钥。

在解释如何获取 OpenAI API 密钥之前,让我们先回顾一下环境变量的相关知识。

什么是环境变量?

环境变量是可供系统上运行的应用程序访问的动态变量。它们通常在操作系统级别设置,可用于存储配置设置、文件路径或其他需要被多个应用程序访问的信息。

环境变量的关键特征:

动态:其值可在运行时更改,从而实现灵活的配置。

系统级:系统上运行的所有应用程序均可访问它们。

名称-值对:每个环境变量都有一个唯一的名称和一个对应的值。

层级式:环境变量可以被子进程继承,从而形成层级结构。

使用环境变量的好处

集中式配置:将配置设置存储在一个位置,便于管理和更新。

提高安全性:避免将敏感信息(例如 API 密钥)直接硬编码到应用程序代码中。

简化部署:无需修改代码即可轻松将应用程序部署到不同环境。

增强灵活性:无需重新部署应用程序即可更改配置设置。

常见环境变量示例

PATH:指定要搜索可执行文件的目录。

HOME:指定用户的主目录。

USER:指定当前用户名。

* `TEMP: `* 指定用于存储临时文件的临时目录。

通过理解环境变量的概念,您可以有效地利用它们来管理配置设置,并提高应用程序的灵活性和安全性。

获取您的 OpenAI API 密钥

要访问 OpenAI 强大的语言模型和工具,您需要一个 API 密钥。此密钥充当您的个人标识符,授予您访问 API 的权限并允许您发出请求。

以下是获取 OpenAI API 密钥的详细步骤指南:

创建 OpenAI 帐户:

OpenAI 登录页面

访问 OpenAI 网站(https://platform.openai.com/login?launch)并注册一个免费帐户。

验证您的电子邮件:

OpenAI会向您提供的邮箱地址发送一封验证邮件。请务必点击邮件中的验证链接以激活您的账户。

导航至 API 密钥:

登录您的 OpenAI 帐户,然后在帐户设置或仪表板中查找“API 密钥”部分。

创建新的 API 密钥:

点击“创建新的 API 密钥”按钮,即可生成一个新的 API 密钥。

复制并保存您的 API 密钥:

请仔细复制生成的 API 密钥并将其保存在安全的地方。切勿与任何人分享您的 API 密钥。妥善保管密钥至关重要,以防止他人未经授权访问您的帐户。
使用 OpenAI API 密钥时,请务必注意以下事项:

安全提示:请始终将您的 API 密钥视为敏感信息。切勿公开分享或与您不信任的人分享。

速率限制: OpenAI 对 API 使用设有速率限制。请注意这些限制,并据此调整您的使用量。

使用方法:请负责任且合乎道德地使用您的 API 密钥。避免将其用于有害或恶意目的。

OpenAI API 可以在 Windows、macOS 和 Linux 等多个操作系统上使用,因此我们将了解如何将 OpenAI API 密钥设置为环境变量。

适用于 Windows

打开命令提示符或 PowerShell:

右键单击“开始”菜单,然后选择“命令提示符”或“Windows PowerShell”。

使用以下setx命令:

执行以下命令,并将“your_api_key_here”替换为您的实际 API 密钥:



setx OPENAI_API_KEY "your_api_key_here"


Enter fullscreen mode Exit fullscreen mode

OPENAI_API_KEY此命令会创建一个以指定值命名的永久环境变量。

重启终端:

关闭并重新打开命令提示符或 PowerShell 窗口,以使更改生效。

适用于 macOS / Linux:

打开终端:

找到并打开终端应用程序。

编辑 Shell 配置文件:

编辑 shell 的配置文件(例如,.bashrc`.sh` .zshrc)。具体文件取决于你使用的 shell(Bash、Zsh 等)。

您通常可以使用文本编辑器(例如 rvmnano或 svg vim)打开此文件:



nano .bashrc


Enter fullscreen mode Exit fullscreen mode

添加环境变量:

将以下行添加到文件中,并将替换"your_api_key_here"为您的 API 密钥:



export OPENAI_API_KEY="your_api_key_here"


Enter fullscreen mode Exit fullscreen mode

保存文件并重启终端

保存对文件所做的更改后,关闭文件并重新启动终端,以使更改生效。

验证环境变量

为确保环境变量已正确设置,您可以在终端中执行以下命令。



echo $OPENAI_API_KEY


Enter fullscreen mode Exit fullscreen mode

如果显示了正确的 API 密钥,则表示环境变量已成功设置。

在应用程序中使用环境变量的示例

设置好 OPENAI_API_KEY 环境变量后,您就可以在 Python 应用程序中轻松访问它。这样就无需将 API 密钥直接硬编码到代码中,从而提高了安全性和可维护性。

导入os模块
要在 Python 中访问环境变量,需要导入 os 模块。该模块提供了与操作系统交互的各种函数。



import os


Enter fullscreen mode Exit fullscreen mode

获取 API 密钥
使用此os.getenv()函数获取环境变量的值OPENAI_API_KEY。此函数接受环境变量名称作为参数,并返回其值;None如果变量未设置,则返回 null。



openai.api_key = os.getenv("OPENAI_API_KEY")


Enter fullscreen mode Exit fullscreen mode

在这个例子中,我们假设你使用openaiPython 库与 OpenAI API 进行交互。该openai.api_key属性用于设置后续请求的 API 密钥。

处理缺失的环境变量

如果环境变量未设置,os.getenv()则会返回 null None。最佳实践是检查此情况并进行适当处理。例如,您可以显示错误消息或退出应用程序。



api_key = os.getenv("OPENAI_API_KEY")
if not api_key:
    print("OpenAI API key not found. Please set the OPENAI_API_KEY environment variable.")
    exit(1)


Enter fullscreen mode Exit fullscreen mode

使用 API 密钥

设置好 API 密钥后,您现在可以向 OpenAI API 发送请求。例如,要使用 Completion API 生成文本,您可以这样做:



response = openai.Completion.create(
    engine="text-davinci-003",
    prompt="Write a poem about a robot who wants to be human.",
)
print(response.choices[0].text)


Enter fullscreen mode Exit fullscreen mode

通过使用环境变量,您可以将应用程序与特定的 API 密钥解耦,使其更加灵活且易于管理。

将 OpenAI API 密钥作为环境变量处理时的最佳实践和注意事项

一般来说,开发者在使用 API 密钥作为环境变量时,应该注意以下几个方面。

安全

  • 切勿公开分享您的 API 密钥。保护 API 密钥的机密性至关重要,可以防止未经授权的访问。

  • 避免将 API 密钥直接硬编码到应用程序代码中。使用环境变量有助于防止 API 密钥意外泄露。

  • 考虑使用 HashiCorp Vault 或 AWS Secrets Manager 等密钥管理工具来安全地存储和管理您的 API 密钥。

环境特定设置

如果您需要为不同的环境(例如,开发环境、生产环境)使用不同的 API 密钥,请考虑使用特定于环境的配置文件或 Docker Secrets 等工具。这样,您就可以在不泄露敏感信息的情况下管理和部署应用程序。

版本控制

  • 避免将 API 密钥提交到 Git 等版本控制系统中。这可以防止 API 密钥意外泄露给他人。

  • 使用环境变量来管理敏感信息,避免将其提交到版本控制系统中。

替代方法

虽然环境变量是一种常见的方法,但还有其他方法可以存储和管理 API 密钥:

  • 配置文件:将 API 密钥存储在配置文件(例如 .env)中,并将其加载到您的应用程序中。

  • 密钥管理工具:使用专门的工具安全地存储和管理 API 密钥等密钥。

结论

通过将 OpenAI API 密钥设置为环境变量,您可以有效地在 Python 应用程序中管理和使用该密钥。这种方法具有以下几个优点:

  • 安全性提升:防止您的 API 密钥意外泄露。

  • 集中式配置:将密钥存储在一个位置,便于管理。

  • 简化部署:无需修改代码即可轻松部署到不同的环境。

  • 增强灵活性:这使您无需重新部署应用程序即可更改 API 密钥。

文章来源:https://dev.to/cyanspray/how-to-set-openai-api-key-as-an-environment-variable-bh6