如何安全地设置OpenAI API密钥(please set your openai api key in config.py or as an environment variable)
设置 OpenAI API 密钥的方法
本文将介绍怎样设置 OpenAI API 密钥,以便您可以正确地使用 OpenAI 的 API 服务。有两种常见的设置 API 密钥的方法,一种是将 API 密钥存储在 .env 文件中,另外一种是将其设置为环境变量。
A. 从 OpenAI Beta 网站获得 API 密钥
首先,您需要到 OpenAI Beta 网站 (https://beta.openai.com/) 创建一个账号并登录。在登录后,您可以找到您的 API 密钥。
B. 设置 API 密钥的两种方法
接下来,我们将详细介绍在 .env 文件和环境变量中设置 API 密钥的步骤。
1. 在 .env 文件中设置
1. 安装 dotenv 模块:首先,您需要安装 dotenv 模块,可使用 pip 进行安装:
pip install python-dotenv
2. 创建 .env 文件:在项目的根目录下创建一个新文件,文件名为 .env。
3. 设置 OPENAI_API_KEY 变量的值:打开 .env 文件,并将您从 OpenAI Beta 网站取得的 API 密钥复制到其中,例如:OPENAI_API_KEY=your-api-key。
2. 将 API 密钥设置为环境变量
1. 在系统属性当选择高级系统设置:打开 Windows 的“控制面板”,点击“系统和安全”。
2. 选择环境变量选项:在“系统”中,点击“高级系统设置”。在弹出窗口的“高级”选项卡下,点击“环境变量”按钮。
3. 创建一个名为 OPENAI_API_KEY 的新变量,并设置其值:在“用户变量”或“系统变量”中,点击“新建”按钮。在“变量名”中输入 OPENAI_API_KEY,并将您从 OpenAI Beta 网站取得的 API 密钥复制到“变量值”中。
IV. 核对进程
在设置完 API 密钥后,您可以进行核对以确保密钥已设置成功,并验证其有效性。
A. 检查 API 密钥会不会设置成功
1. 在 python 代码中导入 dotenv 模块(如果您选择在 .env 文件中设置密钥)。
from dotenv import load_dotenv
2. 在代码中加载 .env 文件(如果您选择在 .env 文件中设置密钥):
load_dotenv()
3. 在代码中读取环境变量,并输出密钥的值:
import os
api_key = os.getenv("OPENAI_API_KEY")
print(api_key)
如果输出与您从 OpenAI Beta 网站取得的密钥相同,那末说明设置成功。
B. 验证 API 密钥的有效性
您可使用一些简单的代码来验证您的 API 密钥会不会有效。
import openai
openai.api_key = api_key # 将 api_key 替换为您的实际密钥
response = openai.Completion.create(
engine="davinci",
prompt="Once upon a time",
max_tokens=5
)
print(response)
如果返回了预期的响应或不出错,那末说明您的 API 密钥有效。
V. 安全性斟酌
为了确保 API 密钥的安全性,请注意以下事项:
A. 不要在代码中直接暴露 API 密钥
避免直接将 API 密钥写在您的代码中,由于这样有泄漏密钥的风险。
B. 通过 .env 文件或环境变量进行安全访问
将 API 密钥存储在 .env 文件或环境变量中,可以更安全地使用密钥。确保不要将 .env 文件或环境变量上传到公共代码库中。
VI. 结论
本文介绍了两种设置 OpenAI API 密钥的方法:在 .env 文件中设置和设置为环境变量。您可以根据自己的需求选择合适的方法,并通过核对和验证来确保密钥的设置正确和有效。