Bootstrap

人工智能LLM | 基础配置 | 通过环境变量配置API-KEY 一文通教程

        在实战开发大语言模型的过程中,经常会遇到各种API-KEY的配置问题,例如GPT OpenAI KEY的配置,而且目前大部分都要求将其配置在环境变量中,下面将会讲解如何在Linux、macOS、Windows中配置,本文一文通教程。

您可以使用配置环境变量的方法,避免在调用各种SDK时显式地配置API-KEY,从而降低泄漏风险。

环境变量是操作系统中用于存储有关系统环境的信息的变量。您可以通过环境变量来配置API-KEY,这样即使您的代码库被公开,API-KEY也不会泄漏。您可以根据您的操作系统与使用场景来确定添加API-KEY到环境变量中的方法。

一、Linux系统配置

当您使用Linux系统(如Ubuntu、CentOS等)中的命令行添加的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

添加临时性环境变量

如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
export OPENAI_API_KEY="YOUR_OPENAI-API-KEY"

上面是展示 GPT 调用的key配置方法。或者还有 kimi 的API-KEY配置:

# 用您的 MOONSHOT API_KEY 代替 YOUR_MOONSHOT_API_KEY
export MOONSHOT_API_KEY = "YOUR_MOONSHOT_API_KEY"

您可以在当前会话运行以下命令检查环境变量是否生效:

echo $DASHSCOPE_API_KEY

对当前用户添加永久性环境变量

如果您想对当前用户添加永久性环境变量,使得在该用户的新会话中也可以使用该环境变量,您可以把以下命令语句复制并添加到~/.bashrc文件中:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
export OPENAI_API_KEY="YOUR_OPENAI-API-KEY"

或直接运行以下命令将上述命令语句添加到~/.bashrc中:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
echo "export OPENAI_API_KEY='YOUR_OPENAI-API-KEY'" >> ~/.bashrc

 添加完成后,您可以运行以下命令使得环境变量生效:

source ~/.bashrc

您可以新建立一个会话,运行以下命令检查环境变量是否生效:

echo $OPENAI_API_KEY

二、macOS系统配置

当您使用macOS系统中的命令行添加OPENAI的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

添加临时性环境变量

如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
export OPENAI_API_KEY="YOUR_OPENAI-API-KEY"

您可以在当前会话运行以下命令检查环境变量是否生效:

echo $OPENAI_API_KEY

对当前用户添加永久性环境变量

如果您想对当前用户添加永久性环境变量,使得在该用户的新会话中也可以使用该环境变量,您可以根据您使用的Shell类型把以下命令复制并添加到~/.zshrc或~/.bash_profile文件中。

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
export OPENAI_API_KEY="YOUR_OPENAI-API-KEY"

或直接运行以下命令将上述命令语句添加到~/.zshrc或~/.bash_profile中:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI_API_KEY
## 如果您的Shell类型是Zsh,运行以下命令
echo "export OPENAI_API_KEY='YOUR_OPENAI_API_KEY'" >> ~/.zshrc

## 如果您的Shell类型是Bash,运行以下命令
echo "export OPENAI_API_KEY='YOUR_OPENAI_API_KEY'" >> ~/.bash_profile

添加完成后,您可以根据您使用的Shell类型运行以下命令使得环境变量生效:

# 如果您的Shell类型是Zsh,运行以下命令
source ~/.zshrc

# 如果您的Shell类型是Bash,运行以下命令
source ~/.bash_profile

您可以新建立一个会话,运行以下命令检查环境变量是否生效:

echo $OPENAI_API_KEY

三、Windows系统配置

在Windows系统中,您可以使用CMD或PowerShell(推荐)运行命令。

CMD模式

当您使用CMD中的命令行添加OPENAI的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

添加临时性环境变量

如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
set OPENAI_API_KEY="YOUR_OPENAI-API-KEY"

您可以在当前会话运行以下命令检查环境变量是否生效:

echo %OPENAI_API_KEY%

对当前用户添加永久性环境变量

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
setx OPENAI_API_KEY="YOUR_OPENAI-API-KEY"

您可以新建立一个会话,运行以下命令检查环境变量是否生效:

echo %OPENAI_API_KEY%

PowerShell模式

当您使用PowerShell中的命令行添加OPENAI的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

添加临时性环境变量

如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
$env:OPENAI_API_KEY="YOUR_OPENAI-API-KEY"

您可以在当前会话运行以下命令检查环境变量是否生效:

echo %OPENAI_API_KEY%

 对当前用户添加永久性环境变量

如果您在PowerShell中需要为当前用户添加永久性环境变量,您可以运行以下命令:

# 用您的 OPENAI API-KEY 代替 YOUR_OPENAI-API-KEY
[Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "YOUR_OPENAI-API-KEY", [EnvironmentVariableTarget]::User)

您可以新建立一个会话,运行以下命令检查环境变量是否生效:

echo %OPENAI_API_KEY%

至此无论是在Linux、macOS、Windows都可以快速的配置环境变量。

;